vcs.maemo.org Git - monky/blob - doc/variables.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   4 <title>Conky Objects</title>
   5 </head>
   6 <body bgcolor="#FFFFFF"><table cellpadding="3">
   7 <tr bgcolor="#eecfa1">
   8 <th>Variable</th>
   9 <th>Arguments () = optional</th>
  10 <th>Explanation</th>
  11 </tr>
  12 <tr bgcolor="#fffafa">
  13 <td align="center">acpiacadapter</td>
  14 <td align="center">(adapter)</td>
  15 <td>ACPI ac adapter state. On linux, the adapter option specifies the
  16         subfolder of /sys/class/power_supply containing the state information (defaults
  17         to "AC"). Other systems ignore it.
  18         <p></p>
  19 </td>
  20 </tr>
  21 <tr bgcolor="#b4cdcd">
  22 <td align="center">acpifan</td>
  23 <td align="center"></td>
  24 <td>ACPI fan state
  25         <p></p>
  26 </td>
  27 </tr>
  28 <tr bgcolor="#fffafa">
  29 <td align="center">acpitemp</td>
  30 <td align="center"></td>
  31 <td>ACPI temperature in C.
  32         <p></p>
  33 </td>
  34 </tr>
  35 <tr bgcolor="#b4cdcd">
  36 <td align="center">addr</td>
  37 <td align="center">(interface)</td>
  38 <td>IP address for an interface, or "No Address" if
  39         no address is assigned.
  40         <p></p>
  41 </td>
  42 </tr>
  43 <tr bgcolor="#fffafa">
  44 <td align="center">addrs</td>
  45 <td align="center">(interface)</td>
  46 <td>IP addresses for an interface (if one - works
  47         like addr). Linux only.
  48         <p></p>
  49 </td>
  50 </tr>
  51 <tr bgcolor="#b4cdcd">
  52 <td align="center">adt746xcpu</td>
  53 <td align="center"></td>
  54 <td>CPU temperature from therm_adt746x
  55         <p></p>
  56 </td>
  57 </tr>
  58 <tr bgcolor="#fffafa">
  59 <td align="center">adt746xfan</td>
  60 <td align="center"></td>
  61 <td>Fan speed from therm_adt746x
  62         <p></p>
  63 </td>
  64 </tr>
  65 <tr bgcolor="#b4cdcd">
  66 <td align="center">alignc</td>
  67 <td align="center">(num)</td>
  68 <td>Align text to centre
  69         <p></p>
  70 </td>
  71 </tr>
  72 <tr bgcolor="#fffafa">
  73 <td align="center">alignr</td>
  74 <td align="center">(num)</td>
  75 <td>Right-justify text, with space of N
  76         <p></p>
  77 </td>
  78 </tr>
  79 <tr bgcolor="#b4cdcd">
  80 <td align="center">apcupsd</td>
  81 <td align="center">host</td>
  82 <td>Sets up the connection to apcupsd daemon. Prints
  83         nothing, defaults to localhost:3551
  84         <p></p>
  85 </td>
  86 </tr>
  87 <tr bgcolor="#fffafa">
  88 <td align="center">apcupsd_cable</td>
  89 <td align="center"></td>
  90 <td>Prints the UPS connection type.
  91         <p></p>
  92 </td>
  93 </tr>
  94 <tr bgcolor="#b4cdcd">
  95 <td align="center">apcupsd_charge</td>
  96 <td align="center"></td>
  97 <td>Current battery capacity in percent.
  98         <p></p>
  99 </td>
 100 </tr>
 101 <tr bgcolor="#fffafa">
 102 <td align="center">apcupsd_lastxfer</td>
 103 <td align="center"></td>
 104 <td>Reason for last transfer from line to battery.
 105         <p></p>
 106 </td>
 107 </tr>
 108 <tr bgcolor="#b4cdcd">
 109 <td align="center">apcupsd_linev</td>
 110 <td align="center"></td>
 111 <td>Nominal input voltage.
 112         <p></p>
 113 </td>
 114 </tr>
 115 <tr bgcolor="#fffafa">
 116 <td align="center">apcupsd_load</td>
 117 <td align="center"></td>
 118 <td>Current load in percent.
 119         <p></p>
 120 </td>
 121 </tr>
 122 <tr bgcolor="#b4cdcd">
 123 <td align="center">apcupsd_loadbar</td>
 124 <td align="center"></td>
 125 <td>Bar showing current load.
 126         <p></p>
 127 </td>
 128 </tr>
 129 <tr bgcolor="#fffafa">
 130 <td align="center">apcupsd_loadgauge</td>
 131 <td align="center">(height),(width)</td>
 132 <td>Gauge that shows current load.
 133         <p></p>
 134 </td>
 135 </tr>
 136 <tr bgcolor="#b4cdcd">
 137 <td align="center">apcupsd_loadgraph</td>
 138 <td align="center">(height),(width) (gradient colour 1) (gradient
 139             colour 2) (scale) (-t) (-l)</td>
 140 <td>History graph of current load.
 141         <p></p>
 142 </td>
 143 </tr>
 144 <tr bgcolor="#fffafa">
 145 <td align="center">apcupsd_model</td>
 146 <td align="center"></td>
 147 <td>Prints the model of the UPS.
 148         <p></p>
 149 </td>
 150 </tr>
 151 <tr bgcolor="#b4cdcd">
 152 <td align="center">apcupsd_name</td>
 153 <td align="center"></td>
 154 <td>Prints the UPS user-defined name.
 155         <p></p>
 156 </td>
 157 </tr>
 158 <tr bgcolor="#fffafa">
 159 <td align="center">apcupsd_status</td>
 160 <td align="center"></td>
 161 <td>Prints current status (on-line, on-battery).
 162         <p></p>
 163 </td>
 164 </tr>
 165 <tr bgcolor="#b4cdcd">
 166 <td align="center">apcupsd_temp</td>
 167 <td align="center"></td>
 168 <td>Current internal temperature.
 169         <p></p>
 170 </td>
 171 </tr>
 172 <tr bgcolor="#fffafa">
 173 <td align="center">apcupsd_timeleft</td>
 174 <td align="center"></td>
 175 <td>Time left to run on battery.
 176         <p></p>
 177 </td>
 178 </tr>
 179 <tr bgcolor="#b4cdcd">
 180 <td align="center">apcupsd_upsmode</td>
 181 <td align="center"></td>
 182 <td>Prints the UPS mode (e.g. standalone).
 183         <p></p>
 184 </td>
 185 </tr>
 186 <tr bgcolor="#fffafa">
 187 <td align="center">apm_adapter</td>
 188 <td align="center"></td>
 189 <td>Display APM AC adapter status (FreeBSD only)
 190         <p></p>
 191 </td>
 192 </tr>
 193 <tr bgcolor="#b4cdcd">
 194 <td align="center">apm_battery_life</td>
 195 <td align="center"></td>
 196 <td>Display APM battery life in percent (FreeBSD
 197         only)
 198         <p></p>
 199 </td>
 200 </tr>
 201 <tr bgcolor="#fffafa">
 202 <td align="center">apm_battery_time</td>
 203 <td align="center"></td>
 204 <td>Display remaining APM battery life in hh:mm:ss or
 205         "unknown" if AC adapterstatus is on-line or charging
 206         (FreeBSD only)
 207         <p></p>
 208 </td>
 209 </tr>
 210 <tr bgcolor="#b4cdcd">
 211 <td align="center">audacious_bar</td>
 212 <td align="center">(height),(width)</td>
 213 <td>Progress bar
 214         <p></p>
 215 </td>
 216 </tr>
 217 <tr bgcolor="#fffafa">
 218 <td align="center">audacious_bitrate</td>
 219 <td align="center"></td>
 220 <td>Bitrate of current tune
 221         <p></p>
 222 </td>
 223 </tr>
 224 <tr bgcolor="#b4cdcd">
 225 <td align="center">audacious_channels</td>
 226 <td align="center"></td>
 227 <td>Number of audio channels of current tune
 228         <p></p>
 229 </td>
 230 </tr>
 231 <tr bgcolor="#fffafa">
 232 <td align="center">audacious_filename</td>
 233 <td align="center"></td>
 234 <td>Full path and filename of current tune
 235         <p></p>
 236 </td>
 237 </tr>
 238 <tr bgcolor="#b4cdcd">
 239 <td align="center">audacious_frequency</td>
 240 <td align="center"></td>
 241 <td>Sampling frequency of current tune
 242         <p></p>
 243 </td>
 244 </tr>
 245 <tr bgcolor="#fffafa">
 246 <td align="center">audacious_length</td>
 247 <td align="center"></td>
 248 <td>Total length of current tune as MM:SS
 249         <p></p>
 250 </td>
 251 </tr>
 252 <tr bgcolor="#b4cdcd">
 253 <td align="center">audacious_length_seconds</td>
 254 <td align="center"></td>
 255 <td>Total length of current tune in seconds
 256         <p></p>
 257 </td>
 258 </tr>
 259 <tr bgcolor="#fffafa">
 260 <td align="center">audacious_main_volume</td>
 261 <td align="center"></td>
 262 <td>The current volume fetched from Audacious
 263         <p></p>
 264 </td>
 265 </tr>
 266 <tr bgcolor="#b4cdcd">
 267 <td align="center">audacious_playlist_length</td>
 268 <td align="center"></td>
 269 <td>Number of tunes in playlist
 270         <p></p>
 271 </td>
 272 </tr>
 273 <tr bgcolor="#fffafa">
 274 <td align="center">audacious_playlist_position</td>
 275 <td align="center"></td>
 276 <td>Playlist position of current tune
 277         <p></p>
 278 </td>
 279 </tr>
 280 <tr bgcolor="#b4cdcd">
 281 <td align="center">audacious_position</td>
 282 <td align="center"></td>
 283 <td>Position of current tune (MM:SS)
 284         <p></p>
 285 </td>
 286 </tr>
 287 <tr bgcolor="#fffafa">
 288 <td align="center">audacious_position_seconds</td>
 289 <td align="center"></td>
 290 <td>Position of current tune in seconds
 291         <p></p>
 292 </td>
 293 </tr>
 294 <tr bgcolor="#b4cdcd">
 295 <td align="center">audacious_status</td>
 296 <td align="center"></td>
 297 <td>Player status (Playing/Paused/Stopped/Not
 298         running)
 299         <p></p>
 300 </td>
 301 </tr>
 302 <tr bgcolor="#fffafa">
 303 <td align="center">audacious_title</td>
 304 <td align="center">(max length)</td>
 305 <td>Title of current tune with optional maximum
 306         length specifier
 307         <p></p>
 308 </td>
 309 </tr>
 310 <tr bgcolor="#b4cdcd">
 311 <td align="center">battery</td>
 312 <td align="center">(num)</td>
 313 <td>Battery status and remaining percentage capacity
 314         of ACPI or APM battery. ACPI battery number can be given as
 315         argument (default is BAT0).
 316         <p></p>
 317 </td>
 318 </tr>
 319 <tr bgcolor="#fffafa">
 320 <td align="center">battery_bar</td>
 321 <td align="center">(height),(width) (num)</td>
 322 <td>Battery percentage remaining of ACPI battery in a
 323         bar. ACPI battery number can be given as argument (default
 324         is BAT0).
 325         <p></p>
 326 </td>
 327 </tr>
 328 <tr bgcolor="#b4cdcd">
 329 <td align="center">battery_percent</td>
 330 <td align="center">(num)</td>
 331 <td>Battery percentage remaining for ACPI battery.
 332         ACPI battery number can be given as argument (default is
 333         BAT0).
 334         <p></p>
 335 </td>
 336 </tr>
 337 <tr bgcolor="#fffafa">
 338 <td align="center">battery_short</td>
 339 <td align="center">(num)</td>
 340 <td>Battery status and remaining percentage capacity
 341         of ACPI or APM battery. ACPI battery number can be given as
 342         argument (default is BAT0). This mode display a short
 343         status, which means that C is displayed instead of
 344         charging, D for discharging, F for full, N for not present,
 345         E for empty and U for unknown.
 346         <p></p>
 347 </td>
 348 </tr>
 349 <tr bgcolor="#b4cdcd">
 350 <td align="center">battery_time</td>
 351 <td align="center">(num)</td>
 352 <td>Battery charge/discharge time remaining of ACPI
 353         battery. ACPI battery number can be given as argument
 354         (default is BAT0).
 355         <p></p>
 356 </td>
 357 </tr>
 358 <tr bgcolor="#fffafa">
 359 <td align="center">blink</td>
 360 <td align="center">text_and_other_conky_vars</td>
 361 <td>Let 'text_and_other_conky_vars' blink on and off.
 362
 363         <p></p>
 364 </td>
 365 </tr>
 366 <tr bgcolor="#b4cdcd">
 367 <td align="center">bmpx_album</td>
 368 <td align="center"></td>
 369 <td>Album in current BMPx track
 370         <p></p>
 371 </td>
 372 </tr>
 373 <tr bgcolor="#fffafa">
 374 <td align="center">bmpx_artist</td>
 375 <td align="center"></td>
 376 <td>Artist in current BMPx track
 377         <p></p>
 378 </td>
 379 </tr>
 380 <tr bgcolor="#b4cdcd">
 381 <td align="center">bmpx_bitrate</td>
 382 <td align="center"></td>
 383 <td>Bitrate of the current BMPx track
 384         <p></p>
 385 </td>
 386 </tr>
 387 <tr bgcolor="#fffafa">
 388 <td align="center">bmpx_title</td>
 389 <td align="center"></td>
 390 <td>Title of the current BMPx track
 391         <p></p>
 392 </td>
 393 </tr>
 394 <tr bgcolor="#b4cdcd">
 395 <td align="center">bmpx_track</td>
 396 <td align="center"></td>
 397 <td>Track number of the current BMPx track
 398         <p></p>
 399 </td>
 400 </tr>
 401 <tr bgcolor="#fffafa">
 402 <td align="center">bmpx_uri</td>
 403 <td align="center"></td>
 404 <td>URI of the current BMPx track
 405         <p></p>
 406 </td>
 407 </tr>
 408 <tr bgcolor="#b4cdcd">
 409 <td align="center">buffers</td>
 410 <td align="center"></td>
 411 <td>Amount of memory buffered
 412         <p></p>
 413 </td>
 414 </tr>
 415 <tr bgcolor="#fffafa">
 416 <td align="center">cached</td>
 417 <td align="center"></td>
 418 <td>Amount of memory cached
 419         <p></p>
 420 </td>
 421 </tr>
 422 <tr bgcolor="#b4cdcd">
 423 <td align="center">cmdline_to_pid</td>
 424 <td align="center">string</td>
 425 <td>PID of the first process that has string in it's
 426         commandline
 427         <p></p>
 428 </td>
 429 </tr>
 430 <tr bgcolor="#fffafa">
 431 <td align="center">color</td>
 432 <td align="center">(color)</td>
 433 <td>Change drawing color to 'color' which is a name of
 434         a color or a hexcode preceded with # (for example #0A1B2C ).
 435         If you use ncurses only the following colors are supported:
 436         red,green,yellow,blue,magenta,cyan,black,white.
 437         <p></p>
 438 </td>
 439 </tr>
 440 <tr bgcolor="#b4cdcd">
 441 <td align="center">colorN</td>
 442 <td align="center"></td>
 443 <td>Change drawing color to colorN configuration
 444         option, where N is a digit between 0 and 9, inclusively.
 445         <p></p>
 446 </td>
 447 </tr>
 448 <tr bgcolor="#fffafa">
 449 <td align="center">combine</td>
 450 <td align="center">var1 var2</td>
 451 <td>Places the lines of var2 to the right of the
 452         lines of var1 separated by the chars that are put between
 453         var1 and var2. For example: ${combine ${head /proc/cpuinfo
 454         2} - ${head /proc/meminfo 1}} gives as output
 455         "cpuinfo_line1 - meminfo_line1" on line 1 and
 456         "cpuinfo_line2 -" on line 2. $combine vars can also be
 457         nested to place more vars next to each other.
 458         <p></p>
 459 </td>
 460 </tr>
 461 <tr bgcolor="#b4cdcd">
 462 <td align="center">conky_build_arch</td>
 463 <td align="center"></td>
 464 <td>CPU architecture Conky was built for
 465         <p></p>
 466 </td>
 467 </tr>
 468 <tr bgcolor="#fffafa">
 469 <td align="center">conky_build_date</td>
 470 <td align="center"></td>
 471 <td>Date Conky was built
 472         <p></p>
 473 </td>
 474 </tr>
 475 <tr bgcolor="#b4cdcd">
 476 <td align="center">conky_version</td>
 477 <td align="center"></td>
 478 <td>Conky version
 479         <p></p>
 480 </td>
 481 </tr>
 482 <tr bgcolor="#fffafa">
 483 <td align="center">cpu</td>
 484 <td align="center">(cpuN)</td>
 485 <td>CPU usage in percents. For SMP machines, the CPU
 486         number can be provided as an argument. ${cpu cpu0} is the
 487         total usage, and ${cpu cpuX} (X &gt;= 1) are individual
 488         CPUs.
 489         <p></p>
 490 </td>
 491 </tr>
 492 <tr bgcolor="#b4cdcd">
 493 <td align="center">cpubar</td>
 494 <td align="center">(cpuN) (height),(width)</td>
 495 <td>Bar that shows CPU usage, height is bar's height
 496         in pixels. See $cpu for more info on SMP.
 497         <p></p>
 498 </td>
 499 </tr>
 500 <tr bgcolor="#fffafa">
 501 <td align="center">cpugauge</td>
 502 <td align="center">(cpuN) (height),(width)</td>
 503 <td>Elliptical gauge that shows CPU usage, height and
 504         width are gauge's vertical and horizontal axis
 505         respectively. See $cpu for more info on SMP.
 506         <p></p>
 507 </td>
 508 </tr>
 509 <tr bgcolor="#b4cdcd">
 510 <td align="center">cpugraph</td>
 511 <td align="center">(cpuN) (height),(width) (gradient colour 1)
 512             (gradient colour 2) (scale) (-t) (-l)</td>
 513 <td>CPU usage graph, with optional colours in hex,
 514         minus the #. See $cpu for more info on SMP. Uses a
 515         logarithmic scale (to see small numbers) when you use the
 516         -l switch. Takes the switch '-t' to use a temperature
 517         gradient, which makes the gradient values change depending
 518         on the amplitude of a particular graph value (try it and
 519         see).
 520         <p></p>
 521 </td>
 522 </tr>
 523 <tr bgcolor="#fffafa">
 524 <td align="center">curl</td>
 525 <td align="center">url (interval_in_minutes)</td>
 526 <td>
 527             <p>Download data from URI using Curl at the
 528             specified interval. The interval may be a floating
 529             point value greater than 0, otherwise defaults to 15
 530             minutes. Most useful when used in conjunction with Lua
 531             and the Lua API. This object is threaded, and once a
 532             thread is created it can't be explicitly destroyed.
 533             One thread will run for each URI specified. You can use
 534             any protocol that Curl supports.</p>
 535         </td>
 536 </tr>
 537 <tr bgcolor="#b4cdcd">
 538 <td align="center">desktop</td>
 539 <td align="center"></td>
 540 <td>Number of the desktop on which conky is running
 541         or the message "Not running in X" if this is the case.
 542         <p></p>
 543 </td>
 544 </tr>
 545 <tr bgcolor="#fffafa">
 546 <td align="center">desktop_name</td>
 547 <td align="center"></td>
 548 <td>Name of the desktop on which conky is running or
 549         the message "Not running in X" if this is the case.
 550         <p></p>
 551 </td>
 552 </tr>
 553 <tr bgcolor="#b4cdcd">
 554 <td align="center">desktop_number</td>
 555 <td align="center"></td>
 556 <td>Number of desktops or the message "Not running in
 557         X" if this is the case.
 558         <p></p>
 559 </td>
 560 </tr>
 561 <tr bgcolor="#fffafa">
 562 <td align="center">disk_protect</td>
 563 <td align="center">device</td>
 564 <td>Disk protection status, if supported (needs
 565         kernel-patch). Prints either "frozen" or "free " (note the
 566         padding).
 567         <p></p>
 568 </td>
 569 </tr>
 570 <tr bgcolor="#b4cdcd">
 571 <td align="center">diskio</td>
 572 <td align="center">(device)</td>
 573 <td>Displays current disk IO. Device is optional, and
 574         takes the form of sda for /dev/sda. Individual partitions
 575         are allowed.
 576         <p></p>
 577 </td>
 578 </tr>
 579 <tr bgcolor="#fffafa">
 580 <td align="center">diskio_read</td>
 581 <td align="center">(device)</td>
 582 <td>Displays current disk IO for reads. Device as in
 583         diskio.
 584         <p></p>
 585 </td>
 586 </tr>
 587 <tr bgcolor="#b4cdcd">
 588 <td align="center">diskio_write</td>
 589 <td align="center">(device)</td>
 590 <td>Displays current disk IO for writes. Device as in
 591         diskio.
 592         <p></p>
 593 </td>
 594 </tr>
 595 <tr bgcolor="#fffafa">
 596 <td align="center">diskiograph</td>
 597 <td align="center">(device) (height),(width) (gradient colour 1)
 598             (gradient colour 2) (scale) (-t) (-l)</td>
 599 <td>Disk IO graph, colours defined in hex, minus the
 600         #. If scale is non-zero, it becomes the scale for the
 601         graph. Uses a logarithmic scale (to see small numbers) when
 602         you use -l switch. Takes the switch '-t' to use a
 603         temperature gradient, which makes the gradient values
 604         change depending on the amplitude of a particular graph
 605         value (try it and see).
 606         <p></p>
 607 </td>
 608 </tr>
 609 <tr bgcolor="#b4cdcd">
 610 <td align="center">diskiograph_read</td>
 611 <td align="center">(device) (height),(width) (gradient colour 1)
 612             (gradient colour 2) (scale) (-t) (-l)</td>
 613 <td>Disk IO graph for reads, colours defined in hex,
 614         minus the #. If scale is non-zero, it becomes the scale for
 615         the graph. Device as in diskio. Uses a logarithmic scale
 616         (to see small numbers) when you use -l switch. Takes the
 617         switch '-t' to use a temperature gradient, which makes the
 618         gradient values change depending on the amplitude of a
 619         particular graph value (try it and see).
 620         <p></p>
 621 </td>
 622 </tr>
 623 <tr bgcolor="#fffafa">
 624 <td align="center">diskiograph_write</td>
 625 <td align="center">(device) (height),(width) (gradient colour 1)
 626             (gradient colour 2) (scale) (-t) (-l)</td>
 627 <td>Disk IO graph for writes, colours defined in hex,
 628         minus the #. If scale is non-zero, it becomes the scale for
 629         the graph. Device as in diskio. Uses a logarithmic scale
 630         (to see small numbers) when you use -l switch. Takes the
 631         switch '-t' to use a temperature gradient, which makes the
 632         gradient values change depending on the amplitude of a
 633         particular graph value (try it and see).
 634         <p></p>
 635 </td>
 636 </tr>
 637 <tr bgcolor="#b4cdcd">
 638 <td align="center">downspeed</td>
 639 <td align="center">(net)</td>
 640 <td>Download speed in suitable IEC units
 641         <p></p>
 642 </td>
 643 </tr>
 644 <tr bgcolor="#fffafa">
 645 <td align="center">downspeedf</td>
 646 <td align="center">(net)</td>
 647 <td>Download speed in KiB with one decimal
 648         <p></p>
 649 </td>
 650 </tr>
 651 <tr bgcolor="#b4cdcd">
 652 <td align="center">downspeedgraph</td>
 653 <td align="center">(netdev) (height),(width) (gradient colour 1)
 654             (gradient colour 2) (scale) (-t) (-l)</td>
 655 <td>Download speed graph, colours defined in hex,
 656         minus the #. If scale is non-zero, it becomes the scale for
 657         the graph. Uses a logarithmic scale (to see small numbers)
 658         when you use -l switch. Takes the switch '-t' to use a
 659         temperature gradient, which makes the gradient values
 660         change depending on the amplitude of a particular graph
 661         value (try it and see).
 662         <p></p>
 663 </td>
 664 </tr>
 665 <tr bgcolor="#fffafa">
 666 <td align="center">draft_mails</td>
 667 <td align="center">(maildir)</td>
 668 <td>Number of mails marked as draft in the specified
 669         mailbox or mail spool if not. Only maildir type mailboxes
 670         are supported, mbox type will return -1.
 671         <p></p>
 672 </td>
 673 </tr>
 674 <tr bgcolor="#b4cdcd">
 675 <td align="center">else</td>
 676 <td align="center"></td>
 677 <td>Text to show if any of the above are not true
 678         <p></p>
 679 </td>
 680 </tr>
 681 <tr bgcolor="#fffafa">
 682 <td align="center">endif</td>
 683 <td align="center"></td>
 684 <td>Ends an $if block.
 685         <p></p>
 686 </td>
 687 </tr>
 688 <tr bgcolor="#b4cdcd">
 689 <td align="center">entropy_avail</td>
 690 <td align="center"></td>
 691 <td>Current entropy available for crypto freaks
 692         <p></p>
 693 </td>
 694 </tr>
 695 <tr bgcolor="#fffafa">
 696 <td align="center">entropy_bar</td>
 697 <td align="center">(height),(width)</td>
 698 <td>Normalized bar of available entropy for crypto
 699         freaks
 700         <p></p>
 701 </td>
 702 </tr>
 703 <tr bgcolor="#b4cdcd">
 704 <td align="center">entropy_perc</td>
 705 <td align="center"></td>
 706 <td>Percentage of entropy available in comparison to
 707         the poolsize
 708         <p></p>
 709 </td>
 710 </tr>
 711 <tr bgcolor="#fffafa">
 712 <td align="center">entropy_poolsize</td>
 713 <td align="center"></td>
 714 <td>Total size of system entropy pool for crypto
 715         freaks
 716         <p></p>
 717 </td>
 718 </tr>
 719 <tr bgcolor="#b4cdcd">
 720 <td align="center">eval</td>
 721 <td align="center">string</td>
 722 <td>Evaluates given string according to the rules of
 723         TEXT interpretation, i.e. parsing any contained text object
 724         specifications into their output, any occuring '$$' into a
 725         single '$' and so on. The output is then being parsed
 726         again.
 727         <p></p>
 728 </td>
 729 </tr>
 730 <tr bgcolor="#fffafa">
 731 <td align="center">eve</td>
 732 <td align="center">api_userid api_key character_id</td>
 733 <td>Fetches your currently training skill from the
 734         Eve Online API servers (http://www.eve-online.com/) and
 735         displays the skill along with the remaining training time.
 736         <p></p>
 737 </td>
 738 </tr>
 739 <tr bgcolor="#b4cdcd">
 740 <td align="center">exec</td>
 741 <td align="center">command</td>
 742 <td>Executes a shell command and displays the output
 743         in conky. warning: this takes a lot more resources than
 744         other variables. I'd recommend coding wanted behaviour in C
 745         and posting a patch.
 746         <p></p>
 747 </td>
 748 </tr>
 749 <tr bgcolor="#fffafa">
 750 <td align="center">execbar</td>
 751 <td align="center">command</td>
 752 <td>Same as exec, except if the first value return is
 753         a value between 0-100, it will use that number for a bar.
 754         The size for bars can be controlled via the
 755         default_bar_size config setting.
 756         <p></p>
 757 </td>
 758 </tr>
 759 <tr bgcolor="#b4cdcd">
 760 <td align="center">execgauge</td>
 761 <td align="center">command</td>
 762 <td>Same as exec, except if the first value returned
 763         is a value between 0-100, it will use that number for a
 764         gauge. The size for gauges can be controlled via the
 765         default_gauge_size config setting.
 766         <p></p>
 767 </td>
 768 </tr>
 769 <tr bgcolor="#fffafa">
 770 <td align="center">execgraph</td>
 771 <td align="center">(-t) (-l) command</td>
 772 <td>Same as execbar, but graphs values. Uses a
 773         logaritmic scale when the log option (-l switch) is given
 774         (to see small numbers). Values still have to be between 0
 775         and 100. The size for graphs can be controlled via the
 776         default_graph_size config setting. Takes the switch '-t' to
 777         use a temperature gradient, which makes the gradient values
 778         change depending on the amplitude of a particular graph
 779         value (try it and see). If -t or -l is your first argument,
 780         you may need to preceed it by a space (' ').
 781         <p></p>
 782 </td>
 783 </tr>
 784 <tr bgcolor="#b4cdcd">
 785 <td align="center">execi</td>
 786 <td align="center">interval command</td>
 787 <td>Same as exec but with specific interval. Interval
 788         can't be less than update_interval in configuration. See
 789         also $texeci
 790         <p></p>
 791 </td>
 792 </tr>
 793 <tr bgcolor="#fffafa">
 794 <td align="center">execibar</td>
 795 <td align="center">interval command</td>
 796 <td>Same as execbar, except with an interval
 797         <p></p>
 798 </td>
 799 </tr>
 800 <tr bgcolor="#b4cdcd">
 801 <td align="center">execigauge</td>
 802 <td align="center">interval command</td>
 803 <td>Same as execgauge, but takes an interval arg and
 804         gauges values.
 805         <p></p>
 806 </td>
 807 </tr>
 808 <tr bgcolor="#fffafa">
 809 <td align="center">execigraph</td>
 810 <td align="center">interval (-t) (-l) command</td>
 811 <td>Same as execgraph, but takes an interval arg and
 812         graphs values. If -t or -l is your first argument, you may
 813         need to preceed it by a space (' ').
 814         <p></p>
 815 </td>
 816 </tr>
 817 <tr bgcolor="#b4cdcd">
 818 <td align="center">execp</td>
 819 <td align="center">command</td>
 820 <td>Executes a shell command and displays the output
 821         in conky. warning: this takes a lot more resources than
 822         other variables. I'd recommend coding wanted behaviour in C
 823         and posting a patch. This differs from $exec in that it
 824         parses the output of the command, so you can insert things
 825         like ${color red}hi!${color} in your script and have it
 826         correctly parsed by Conky. Caveats: Conky parses and
 827         evaluates the output of $execp every time Conky loops, and
 828         then destroys all the objects. If you try to use anything
 829         like $execi within an $execp statement, it will
 830         functionally run at the same interval that the $execp
 831         statement runs, as it is created and destroyed at every
 832         interval.
 833         <p></p>
 834 </td>
 835 </tr>
 836 <tr bgcolor="#fffafa">
 837 <td align="center">execpi</td>
 838 <td align="center">interval command</td>
 839 <td>Same as execp but with specific interval.
 840         Interval can't be less than update_interval in
 841         configuration. Note that the output from the $execpi
 842         command is still parsed and evaluated at every interval.
 843         <p></p>
 844 </td>
 845 </tr>
 846 <tr bgcolor="#b4cdcd">
 847 <td align="center">flagged_mails</td>
 848 <td align="center">(maildir)</td>
 849 <td>Number of mails marked as flagged in the
 850         specified mailbox or mail spool if not. Only maildir type
 851         mailboxes are supported, mbox type will return -1.
 852         <p></p>
 853 </td>
 854 </tr>
 855 <tr bgcolor="#fffafa">
 856 <td align="center">font</td>
 857 <td align="center">(font)</td>
 858 <td>Specify a different font. This new font will
 859         apply to the current line and everything following. You can
 860         use a $font with no arguments to change back to the default
 861         font (much like with $color)
 862         <p></p>
 863 </td>
 864 </tr>
 865 <tr bgcolor="#b4cdcd">
 866 <td align="center">format_time</td>
 867 <td align="center">seconds format</td>
 868 <td>Format time given in seconds. This var only works when
 869         the times_in_seconds configuration setting is on. Format is a string
 870         that should start and end with a "-char. The "-chars are not
 871         part of the output, \w,\d,\h,\m,\s,\(,\) and \\ are replaced by
 872         weeks,days,hours,minutes,seconds,(,) and \. If you leave out a unit,
 873         it's value will be expressed in the highest unite lower then the
 874         one left out. Text between ()-chars will not be visible if a
 875         replaced unit in this text is 0. If seconds is a decimal number
 876         then you can see the numbers behind the point by using \S
 877         followed by a number that specifies the amount of
 878         digits behind the point that you want to see (maximum 9).
 879         You can also place a 'x' behind \S so you have all digits behind
 880         the point and no trailing zero's. (also maximum 9)
 881         <p></p>
 882 </td>
 883 </tr>
 884 <tr bgcolor="#fffafa">
 885 <td align="center">forwarded_mails</td>
 886 <td align="center">(maildir)</td>
 887 <td>Number of mails marked as forwarded in the
 888         specified mailbox or mail spool if not. Only maildir type
 889         mailboxes are supported, mbox type will return -1.
 890         <p></p>
 891 </td>
 892 </tr>
 893 <tr bgcolor="#b4cdcd">
 894 <td align="center">freq</td>
 895 <td align="center">(n)</td>
 896 <td>Returns CPU #n's frequency in MHz. CPUs are
 897         counted from 1. If omitted, the parameter defaults to 1.
 898         <p></p>
 899 </td>
 900 </tr>
 901 <tr bgcolor="#fffafa">
 902 <td align="center">freq_g</td>
 903 <td align="center">(n)</td>
 904 <td>Returns CPU #n's frequency in GHz. CPUs are
 905         counted from 1. If omitted, the parameter defaults to 1.
 906         <p></p>
 907 </td>
 908 </tr>
 909 <tr bgcolor="#b4cdcd">
 910 <td align="center">fs_bar</td>
 911 <td align="center">(height),(width) fs</td>
 912 <td>Bar that shows how much space is used on a file
 913         system. height is the height in pixels. fs is any file on
 914         that file system.
 915         <p></p>
 916 </td>
 917 </tr>
 918 <tr bgcolor="#fffafa">
 919 <td align="center">fs_bar_free</td>
 920 <td align="center">(height),(width) fs</td>
 921 <td>Bar that shows how much space is free on a file
 922         system. height is the height in pixels. fs is any file on
 923         that file system.
 924         <p></p>
 925 </td>
 926 </tr>
 927 <tr bgcolor="#b4cdcd">
 928 <td align="center">fs_free</td>
 929 <td align="center">(fs)</td>
 930 <td>Free space on a file system available for users.
 931         <p></p>
 932 </td>
 933 </tr>
 934 <tr bgcolor="#fffafa">
 935 <td align="center">fs_free_perc</td>
 936 <td align="center">(fs)</td>
 937 <td>Free percentage of space on a file system
 938         available for users.
 939         <p></p>
 940 </td>
 941 </tr>
 942 <tr bgcolor="#b4cdcd">
 943 <td align="center">fs_size</td>
 944 <td align="center">(fs)</td>
 945 <td>File system size.
 946         <p></p>
 947 </td>
 948 </tr>
 949 <tr bgcolor="#fffafa">
 950 <td align="center">fs_type</td>
 951 <td align="center">(fs)</td>
 952 <td>File system type.
 953         <p></p>
 954 </td>
 955 </tr>
 956 <tr bgcolor="#b4cdcd">
 957 <td align="center">fs_used</td>
 958 <td align="center">(fs)</td>
 959 <td>File system used space.
 960         <p></p>
 961 </td>
 962 </tr>
 963 <tr bgcolor="#fffafa">
 964 <td align="center">fs_used_perc</td>
 965 <td align="center">(fs)</td>
 966 <td>Percent of file system used space.
 967         <p></p>
 968 </td>
 969 </tr>
 970 <tr bgcolor="#b4cdcd">
 971 <td align="center">goto</td>
 972 <td align="center">x</td>
 973 <td>The next element will be printed at position 'x'.
 974
 975         <p></p>
 976 </td>
 977 </tr>
 978 <tr bgcolor="#fffafa">
 979 <td align="center">gw_iface</td>
 980 <td align="center"></td>
 981 <td>Displays the default route's interface or
 982         "multiple"/"none" accordingly.
 983         <p></p>
 984 </td>
 985 </tr>
 986 <tr bgcolor="#b4cdcd">
 987 <td align="center">gw_ip</td>
 988 <td align="center"></td>
 989 <td>Displays the default gateway's IP or
 990         "multiple"/"none" accordingly.
 991         <p></p>
 992 </td>
 993 </tr>
 994 <tr bgcolor="#fffafa">
 995 <td align="center">hddtemp</td>
 996 <td align="center">(dev)</td>
 997 <td>Displays temperature of a selected hard disk
 998                 drive as reported by the hddtemp daemon. Use hddtemp_host
 999                 and hddtemp_port to specify a host and port for all hddtemp
1000                 objects. If no dev parameter is given, the first disk returned
1001                 by the hddtemp daemon is used.
1002         <p></p>
1003 </td>
1004 </tr>
1005 <tr bgcolor="#b4cdcd">
1006 <td align="center">head</td>
1007 <td align="center">logfile lines (next_check)</td>
1008 <td>Displays first N lines of supplied text file. The
1009         file is checked every 'next_check' update. If next_check is
1010         not supplied, Conky defaults to 2. Max of 30 lines can be
1011         displayed, or until the text buffer is filled.
1012         <p></p>
1013 </td>
1014 </tr>
1015 <tr bgcolor="#fffafa">
1016 <td align="center">hr</td>
1017 <td align="center">(height)</td>
1018 <td>Horizontal line, height is the height in pixels
1019         <p></p>
1020 </td>
1021 </tr>
1022 <tr bgcolor="#b4cdcd">
1023 <td align="center">hwmon</td>
1024 <td align="center">(dev) type n (factor offset)</td>
1025 <td>Hwmon sensor from sysfs (Linux 2.6). Parameter
1026         dev may be omitted if you have only one hwmon device.
1027         Parameter type is either 'in' or 'vol' meaning voltage;
1028         'fan' meaning fan; 'temp' meaning temperature. Parameter n
1029         is number of the sensor. See /sys/class/hwmon/ on your
1030         local computer. The optional arguments 'factor' and
1031         'offset' allow precalculation of the raw input, which is
1032         being modified as follows: 'input = input * factor +
1033         offset'. Note that they have to be given as decimal values
1034         (i.e. contain at least one decimal place).
1035         <p></p>
1036 </td>
1037 </tr>
1038 <tr bgcolor="#fffafa">
1039 <td align="center">i2c</td>
1040 <td align="center">(dev) type n (factor offset)</td>
1041 <td>I2C sensor from sysfs (Linux 2.6). Parameter dev
1042         may be omitted if you have only one I2C device. Parameter
1043         type is either 'in' or 'vol' meaning voltage; 'fan' meaning
1044         fan; 'temp' meaning temperature. Parameter n is number of
1045         the sensor. See /sys/bus/i2c/devices/ on your local
1046         computer. The optional arguments 'factor' and 'offset'
1047         allow precalculation of the raw input, which is being
1048         modified as follows: 'input = input * factor + offset'.
1049         Note that they have to be given as decimal values (i.e.
1050         contain at least one decimal place).
1051         <p></p>
1052 </td>
1053 </tr>
1054 <tr bgcolor="#b4cdcd">
1055 <td align="center">i8k_ac_status</td>
1056 <td align="center"></td>
1057 <td>If running the i8k kernel driver for Inspiron
1058         laptops, displays whether ac power is on, as listed in
1059         /proc/i8k (translated to human-readable). Beware that this
1060         is by default not enabled by i8k itself.
1061         <p></p>
1062 </td>
1063 </tr>
1064 <tr bgcolor="#fffafa">
1065 <td align="center">i8k_bios</td>
1066 <td align="center"></td>
1067 <td>If running the i8k kernel driver for Inspiron
1068         laptops, displays the bios version as listed in /proc/i8k.
1069         <p></p>
1070 </td>
1071 </tr>
1072 <tr bgcolor="#b4cdcd">
1073 <td align="center">i8k_buttons_status</td>
1074 <td align="center"></td>
1075 <td>If running the i8k kernel driver for Inspiron
1076         laptops, displays the volume buttons status as listed in
1077         /proc/i8k.
1078         <p></p>
1079 </td>
1080 </tr>
1081 <tr bgcolor="#fffafa">
1082 <td align="center">i8k_cpu_temp</td>
1083 <td align="center"></td>
1084 <td>If running the i8k kernel driver for Inspiron
1085         laptops, displays the cpu temperature in Celsius, as
1086         reported by /proc/i8k.
1087         <p></p>
1088 </td>
1089 </tr>
1090 <tr bgcolor="#b4cdcd">
1091 <td align="center">i8k_left_fan_rpm</td>
1092 <td align="center"></td>
1093 <td>If running the i8k kernel driver for Inspiron
1094         laptops, displays the left fan's rate of rotation, in
1095         revolutions per minute as listed in /proc/i8k. Beware, some
1096         laptops i8k reports these fans in reverse order.
1097         <p></p>
1098 </td>
1099 </tr>
1100 <tr bgcolor="#fffafa">
1101 <td align="center">i8k_left_fan_status</td>
1102 <td align="center"></td>
1103 <td>If running the i8k kernel driver for Inspiron
1104         laptops, displays the left fan status as listed in
1105         /proc/i8k (translated to human-readable). Beware, some
1106         laptops i8k reports these fans in reverse order.
1107         <p></p>
1108 </td>
1109 </tr>
1110 <tr bgcolor="#b4cdcd">
1111 <td align="center">i8k_right_fan_rpm</td>
1112 <td align="center"></td>
1113 <td>If running the i8k kernel driver for Inspiron
1114         laptops, displays the right fan's rate of rotation, in
1115         revolutions per minute as listed in /proc/i8k. Beware, some
1116         laptops i8k reports these fans in reverse order.
1117         <p></p>
1118 </td>
1119 </tr>
1120 <tr bgcolor="#fffafa">
1121 <td align="center">i8k_right_fan_status</td>
1122 <td align="center"></td>
1123 <td>If running the i8k kernel driver for Inspiron
1124         laptops, displays the right fan status as listed in
1125         /proc/i8k (translated to human-readable). Beware, some
1126         laptops i8k reports these fans in reverse order.
1127         <p></p>
1128 </td>
1129 </tr>
1130 <tr bgcolor="#b4cdcd">
1131 <td align="center">i8k_serial</td>
1132 <td align="center"></td>
1133 <td>If running the i8k kernel driver for Inspiron
1134         laptops, displays your laptop serial number as listed in
1135         /proc/i8k.
1136         <p></p>
1137 </td>
1138 </tr>
1139 <tr bgcolor="#fffafa">
1140 <td align="center">i8k_version</td>
1141 <td align="center"></td>
1142 <td>If running the i8k kernel driver for Inspiron
1143         laptops, displays the version formatting of /proc/i8k.
1144         <p></p>
1145 </td>
1146 </tr>
1147 <tr bgcolor="#b4cdcd">
1148 <td align="center">ibm_brightness</td>
1149 <td align="center"></td>
1150 <td>If running the IBM ACPI, displays the brigtness
1151         of the laptops's LCD (0-7).
1152         <p></p>
1153 </td>
1154 </tr>
1155 <tr bgcolor="#fffafa">
1156 <td align="center">ibm_fan</td>
1157 <td align="center"></td>
1158 <td>If running the IBM ACPI, displays the fan speed.
1159         <p></p>
1160 </td>
1161 </tr>
1162 <tr bgcolor="#b4cdcd">
1163 <td align="center">ibm_temps</td>
1164 <td align="center">N</td>
1165 <td>If running the IBM ACPI, displays the
1166         temperatures from the IBM temperature sensors (N=0..7)
1167         Sensor 0 is on the CPU, 3 is on the GPU.
1168         <p></p>
1169 </td>
1170 </tr>
1171 <tr bgcolor="#fffafa">
1172 <td align="center">ibm_volume</td>
1173 <td align="center"></td>
1174 <td>If running the IBM ACPI, displays the "master"
1175         volume, controlled by the volume keys (0-14).
1176         <p></p>
1177 </td>
1178 </tr>
1179 <tr bgcolor="#b4cdcd">
1180 <td align="center">iconv_start</td>
1181 <td align="center">codeset_from codeset_to</td>
1182 <td>Convert text from one codeset to another using
1183         GNU iconv. Needs to be stopped with iconv_stop.
1184         <p></p>
1185 </td>
1186 </tr>
1187 <tr bgcolor="#fffafa">
1188 <td align="center">iconv_stop</td>
1189 <td align="center"></td>
1190 <td>Stop iconv codeset conversion.
1191         <p></p>
1192 </td>
1193 </tr>
1194 <tr bgcolor="#b4cdcd">
1195 <td align="center">if_empty</td>
1196 <td align="center">(var)</td>
1197 <td>if conky variable VAR is empty, display
1198         everything between $if_empty and the matching $endif
1199         <p></p>
1200 </td>
1201 </tr>
1202 <tr bgcolor="#fffafa">
1203 <td align="center">if_existing</td>
1204 <td align="center">file (string)</td>
1205 <td>if FILE exists, display everything between
1206         if_existing and the matching $endif. The optional second
1207         paramater checks for FILE containing the specified string
1208         and prints everything between $if_existing and the matching
1209         $endif.
1210         <p></p>
1211 </td>
1212 </tr>
1213 <tr bgcolor="#b4cdcd">
1214 <td align="center">if_gw</td>
1215 <td align="center"></td>
1216 <td>if there is at least one default gateway, display
1217         everything between $if_gw and the matching $endif
1218         <p></p>
1219 </td>
1220 </tr>
1221 <tr bgcolor="#fffafa">
1222 <td align="center">if_match</td>
1223 <td align="center">expression</td>
1224 <td>Evaluates the given boolean expression, printing
1225         everything between $if_match and the matching $endif
1226         depending on whether the evaluation returns true or not.
1227         Valid expressions consist of a left side, an operator and a
1228         right side. Left and right sides are being parsed for
1229         contained text objects before evaluation. Recognised left
1230         and right side types are:
1231         <ul>
1232 <li>
1233             <strong>double</strong> -
1234         Argument consists of only
1235             digits and a single dot.</li>
1236 <li>
1237             <strong>long</strong> -
1238         Argument consists of only
1239             digits.</li>
1240 <li>
1241             <strong>string</strong> -
1242         Argument is enclosed in
1243             quotation marks (")</li>
1244 </ul>Valid operands are: '&gt;', '&lt;', '&gt;=',
1245         '&lt;=', '==', '!='.
1246         <p></p>
1247 </td>
1248 </tr>
1249 <tr bgcolor="#b4cdcd">
1250 <td align="center">if_mixer_mute</td>
1251 <td align="center">(mixer)</td>
1252 <td>If mixer exists, display everything between
1253         $if_mixer_mute and the matching $endif. If no mixer is
1254         specified, "Master" is used.
1255         <p></p>
1256 </td>
1257 </tr>
1258 <tr bgcolor="#fffafa">
1259 <td align="center">if_mounted</td>
1260 <td align="center">(mountpoint)</td>
1261 <td>if MOUNTPOINT is mounted, display everything
1262         between $if_mounted and the matching $endif
1263         <p></p>
1264 </td>
1265 </tr>
1266 <tr bgcolor="#b4cdcd">
1267 <td align="center">if_mpd_playing</td>
1268 <td align="center"></td>
1269 <td>if mpd is playing or paused, display everything
1270         between $if_mpd_playing and the matching $endif
1271         <p></p>
1272 </td>
1273 </tr>
1274 <tr bgcolor="#fffafa">
1275 <td align="center">if_running</td>
1276 <td align="center">(process)</td>
1277 <td>if PROCESS is running, display everything
1278         $if_running and the matching $endif. This uses the
1279         ``pidof'' command, so the -x switch is also supported.
1280         <p></p>
1281 </td>
1282 </tr>
1283 <tr bgcolor="#b4cdcd">
1284 <td align="center">if_smapi_bat_installed</td>
1285 <td align="center">(INDEX)</td>
1286 <td>when using smapi, if the battery with index INDEX
1287         is installed, display everything between
1288         $if_smapi_bat_installed and the matching $endif
1289         <p></p>
1290 </td>
1291 </tr>
1292 <tr bgcolor="#fffafa">
1293 <td align="center">if_up</td>
1294 <td align="center">(interface)</td>
1295 <td>if INTERFACE exists and is up, display everything
1296         between $if_up and the matching $endif
1297         <p></p>
1298 </td>
1299 </tr>
1300 <tr bgcolor="#b4cdcd">
1301 <td align="center">if_updatenr</td>
1302 <td align="center">(updatenr)</td>
1303 <td>If it's the UPDATENR-th time that conky updates,
1304         display everything between $if_updatenr and the matching
1305         $endif. The counter resets when the highest UPDATENR is
1306         reached. Example : "{$if_updatenr 1}foo$endif{$if_updatenr
1307         2}bar$endif{$if_updatenr 4}$endif" shows foo 25% of the
1308         time followed by bar 25% of the time followed by nothing
1309         the other half of the time.
1310         <p></p>
1311 </td>
1312 </tr>
1313 <tr bgcolor="#fffafa">
1314 <td align="center">if_xmms2_connected</td>
1315 <td align="center"></td>
1316 <td>Display everything between $if_xmms2_connected
1317         and the matching $endif if xmms2 is running.
1318         <p></p>
1319 </td>
1320 </tr>
1321 <tr bgcolor="#b4cdcd">
1322 <td align="center">image</td>
1323 <td align="center">&lt;path to image&gt; (-p x,y) (-s WxH) (-n)
1324             (-f interval)</td>
1325 <td>Renders an image from the path specified using
1326         Imlib2. Takes 4 optional arguments: a position, a size, a
1327         no-cache switch, and a cache flush interval. Changing the
1328         x,y position will move the position of the image, and
1329         changing the WxH will scale the image. If you specify the
1330         no-cache flag (-n), the image will not be cached.
1331         Alternately, you can specify the -f int switch to specify a
1332         cache flust interval for a particular image. Example:
1333         ${image /home/brenden/cheeseburger.jpg -p 20,20 -s 200x200}
1334         will render 'cheeseburger.jpg' at (20,20) scaled to 200x200
1335         pixels. Conky does not make any attempt to adjust the
1336         position (or any other formatting) of images, they are just
1337         rendered as per the arguments passed. The only reason
1338         $image is part of the TEXT section, is to allow for runtime
1339         modifications, through $execp $lua_parse, or some other
1340         method.
1341         <p></p>
1342 </td>
1343 </tr>
1344 <tr bgcolor="#fffafa">
1345 <td align="center">imap_messages</td>
1346 <td align="center">(args)</td>
1347 <td>Displays the number of messages in your global
1348         IMAP inbox by default. You can define individual IMAP
1349         inboxes separately by passing arguments to this object.
1350         Arguments are: "host user pass [-i interval (in seconds)]
1351         [-f 'folder'] [-p port] [-e 'command'] [-r retries]". Default
1352         port is 143, default folder is 'INBOX', default interval is
1353         5 minutes, and default number of retries before giving up
1354         is 5. If the password is supplied as '*', you will be
1355         prompted to enter the password when Conky starts.
1356         <p></p>
1357 </td>
1358 </tr>
1359 <tr bgcolor="#b4cdcd">
1360 <td align="center">imap_unseen</td>
1361 <td align="center">(args)</td>
1362 <td>Displays the number of unseen messages in your
1363         global IMAP inbox by default. You can define individual
1364         IMAP inboxes separately by passing arguments to this
1365         object. Arguments are: "host user pass [-i interval (in
1366         seconds)] [-f 'folder'] [-p port] [-e 'command'] [-r retries]".
1367         Default port is 143, default folder is 'INBOX', default
1368         interval is 5 minutes, and default number of retries before
1369         giving up is 5. If the password is supplied as '*', you
1370         will be prompted to enter the password when Conky starts.
1371         <p></p>
1372 </td>
1373 </tr>
1374 <tr bgcolor="#fffafa">
1375 <td align="center">include</td>
1376 <td align="center">path</td>
1377 <td>
1378             <p>Loads the configfile at path, places the
1379             configsettings behind the configsettings in the orginal
1380             config and places the vars where the includevar
1381             stood.</p>
1382         </td>
1383 </tr>
1384 <tr bgcolor="#b4cdcd">
1385 <td align="center">ioscheduler</td>
1386 <td align="center">disk</td>
1387 <td>Prints the current ioscheduler used for the given
1388         disk name (i.e. e.g. "hda" or "sdb")
1389         <p></p>
1390 </td>
1391 </tr>
1392 <tr bgcolor="#fffafa">
1393 <td align="center">kernel</td>
1394 <td align="center"></td>
1395 <td>Kernel version
1396         <p></p>
1397 </td>
1398 </tr>
1399 <tr bgcolor="#b4cdcd">
1400 <td align="center">laptop_mode</td>
1401 <td align="center"></td>
1402 <td>The value of /proc/sys/vm/laptop_mode
1403         <p></p>
1404 </td>
1405 </tr>
1406 <tr bgcolor="#fffafa">
1407 <td align="center">lines</td>
1408 <td align="center">textfile</td>
1409 <td>Displays the number of lines in the given file
1410         <p></p>
1411 </td>
1412 </tr>
1413 <tr bgcolor="#b4cdcd">
1414 <td align="center">loadavg</td>
1415 <td align="center">(1|2|3)</td>
1416 <td>System load average, 1 is for past 1 minute, 2
1417         for past 5 minutes and 3 for past 15 minutes. Without argument, prints
1418         all three values separated by whitespace.
1419         <p></p>
1420 </td>
1421 </tr>
1422 <tr bgcolor="#fffafa">
1423 <td align="center">loadgraph</td>
1424 <td align="center">(height),(width) (gradient colour 1)
1425             (gradient colour 2) (scale) (-t) (-l)</td>
1426 <td>Load1 average graph, similar to xload, with
1427         optional colours in hex, minus the #. Uses a logarithmic
1428         scale (to see small numbers) when you use the -l switch.
1429         Takes the switch '-t' to use a temperature gradient, which
1430         makes the gradient values change depending on the amplitude
1431         of a particular graph value (try it and see).
1432         <p></p>
1433 </td>
1434 </tr>
1435 <tr bgcolor="#b4cdcd">
1436 <td align="center">lua</td>
1437 <td align="center">function_name (function parameters)</td>
1438 <td>Executes a Lua function with given parameters,
1439         then prints the returned string. See also 'lua_load' on how
1440         to load scripts. Conky puts 'conky_' in front of
1441         function_name to prevent accidental calls to the wrong
1442         function unless you put you place 'conky_' in front of it
1443         yourself.
1444         <p></p>
1445 </td>
1446 </tr>
1447 <tr bgcolor="#fffafa">
1448 <td align="center">lua_bar</td>
1449 <td align="center">(height, width) function_name (function
1450             parameters)</td>
1451 <td>Executes a Lua function with given parameters and
1452         draws a bar. Expects result value to be an integer between
1453         0 and 100. See also 'lua_load' on how to load scripts.
1454         Conky puts 'conky_' in front of function_name to prevent
1455         accidental calls to the wrong function unless you put you
1456         place 'conky_' in front of it yourself.
1457         <p></p>
1458 </td>
1459 </tr>
1460 <tr bgcolor="#b4cdcd">
1461 <td align="center">lua_gauge</td>
1462 <td align="center">(height, width) function_name (function
1463             parameters)</td>
1464 <td>Executes a Lua function with given parameters and
1465         draws a gauge. Expects result value to be an integer
1466         between 0 and 100. See also 'lua_load' on how to load
1467         scripts. Conky puts 'conky_' in front of function_name to
1468         prevent accidental calls to the wrong function unless you
1469         put you place 'conky_' in front of it yourself.
1470         <p></p>
1471 </td>
1472 </tr>
1473 <tr bgcolor="#fffafa">
1474 <td align="center">lua_graph</td>
1475 <td align="center">function_name (height),(width) (gradient colour
1476             1) (gradient colour 2) (scale) (-t) (-l)</td>
1477 <td>Executes a Lua function with and draws a graph.
1478         Expects result value to be any number, and by default will
1479         scale to show the full range. See also 'lua_load' on how to
1480         load scripts. Takes the switch '-t' to use a temperature
1481         gradient, which makes the gradient values change depending
1482         on the amplitude of a particular graph value (try it and
1483         see). Conky puts 'conky_' in front of function_name to
1484         prevent accidental calls to the wrong function unless you
1485         put you place 'conky_' in front of it yourself.
1486         <p></p>
1487 </td>
1488 </tr>
1489 <tr bgcolor="#b4cdcd">
1490 <td align="center">lua_parse</td>
1491 <td align="center">function_name (function parameters)</td>
1492 <td>Executes a Lua function with given parameters as
1493         per $lua, then parses and prints the result value as per
1494         the syntax for Conky's TEXT section. See also 'lua_load' on
1495         how to load scripts. Conky puts 'conky_' in front of
1496         function_name to prevent accidental calls to the wrong
1497         function unless you put you place 'conky_' in front of it
1498         yourself.
1499         <p></p>
1500 </td>
1501 </tr>
1502 <tr bgcolor="#fffafa">
1503 <td align="center">machine</td>
1504 <td align="center"></td>
1505 <td>Machine, i686 for example
1506         <p></p>
1507 </td>
1508 </tr>
1509 <tr bgcolor="#b4cdcd">
1510 <td align="center">mails</td>
1511 <td align="center">(mailbox)</td>
1512 <td>Mail count in the specified mailbox or your mail
1513         spool if not. Both mbox and maildir type mailboxes are
1514         supported. You can use a program like fetchmail to get
1515         mails from some server using your favourite protocol. See
1516         also new_mails.
1517         <p></p>
1518 </td>
1519 </tr>
1520 <tr bgcolor="#fffafa">
1521 <td align="center">mboxscan</td>
1522 <td align="center">(-n number of messages to print) (-fw from
1523             width) (-sw subject width) mbox</td>
1524 <td>Print a summary of recent messages in an mbox
1525         format mailbox. mbox parameter is the filename of the
1526         mailbox (can be encapsulated using '"', ie. ${mboxscan -n
1527         10 "/home/brenden/some box"}
1528         <p></p>
1529 </td>
1530 </tr>
1531 <tr bgcolor="#b4cdcd">
1532 <td align="center">mem</td>
1533 <td align="center"></td>
1534 <td>Amount of memory in use
1535         <p></p>
1536 </td>
1537 </tr>
1538 <tr bgcolor="#fffafa">
1539 <td align="center">membar</td>
1540 <td align="center">(height),(width)</td>
1541 <td>Bar that shows amount of memory in use
1542         <p></p>
1543 </td>
1544 </tr>
1545 <tr bgcolor="#b4cdcd">
1546 <td align="center">memeasyfree</td>
1547 <td align="center"></td>
1548 <td>Amount of free memory including the memory that
1549         is very easily freed (buffers/cache)
1550         <p></p>
1551 </td>
1552 </tr>
1553 <tr bgcolor="#fffafa">
1554 <td align="center">memfree</td>
1555 <td align="center"></td>
1556 <td>Amount of free memory
1557         <p></p>
1558 </td>
1559 </tr>
1560 <tr bgcolor="#b4cdcd">
1561 <td align="center">memgauge</td>
1562 <td align="center">(height),(width)</td>
1563 <td>Gauge that shows amount of memory in use (see
1564         cpugauge)
1565         <p></p>
1566 </td>
1567 </tr>
1568 <tr bgcolor="#fffafa">
1569 <td align="center">memgraph</td>
1570 <td align="center">(height),(width) (gradient colour 1) (gradient
1571             colour 2) (scale) (-t) (-l)</td>
1572 <td>Memory usage graph. Uses a logarithmic scale (to
1573         see small numbers) when you use the -l switch. Takes the
1574         switch '-t' to use a temperature gradient, which makes the
1575         gradient values change depending on the amplitude of a
1576         particular graph value (try it and see).
1577         <p></p>
1578 </td>
1579 </tr>
1580 <tr bgcolor="#b4cdcd">
1581 <td align="center">memmax</td>
1582 <td align="center"></td>
1583 <td>Total amount of memory
1584         <p></p>
1585 </td>
1586 </tr>
1587 <tr bgcolor="#fffafa">
1588 <td align="center">memperc</td>
1589 <td align="center"></td>
1590 <td>Percentage of memory in use
1591         <p></p>
1592 </td>
1593 </tr>
1594 <tr bgcolor="#b4cdcd">
1595 <td align="center">mixer</td>
1596 <td align="center">(device)</td>
1597 <td>Prints the mixer value as reported by the OS.
1598         Default mixer is "Master", but you can specify one of the
1599         available ALSA Simple mixer controls.
1600         You can find the list of those available on your system
1601         using amixer.
1602         <p></p>
1603 </td>
1604 </tr>
1605 <tr bgcolor="#fffafa">
1606 <td align="center">mixerbar</td>
1607 <td align="center">(device)</td>
1608 <td>Displays mixer value in a bar as reported by the
1609         OS. See docs for $mixer for details on arguments.
1610         <p></p>
1611 </td>
1612 </tr>
1613 <tr bgcolor="#b4cdcd">
1614 <td align="center">mixerl</td>
1615 <td align="center">(device)</td>
1616 <td>Prints the left channel mixer value as reported
1617         by the OS. See docs for $mixer for details on arguments.
1618         <p></p>
1619 </td>
1620 </tr>
1621 <tr bgcolor="#fffafa">
1622 <td align="center">mixerlbar</td>
1623 <td align="center">(device)</td>
1624 <td>Displays the left channel mixer value in a bar as
1625         reported by the OS. See docs for $mixer for details on
1626         arguments.
1627         <p></p>
1628 </td>
1629 </tr>
1630 <tr bgcolor="#b4cdcd">
1631 <td align="center">mixerr</td>
1632 <td align="center">(device)</td>
1633 <td>Prints the right channel mixer value as reported
1634         by the OS. See docs for $mixer for details on arguments.
1635         <p></p>
1636 </td>
1637 </tr>
1638 <tr bgcolor="#fffafa">
1639 <td align="center">mixerrbar</td>
1640 <td align="center">(device)</td>
1641 <td>Displays the right channel mixer value in a bar
1642         as reported by the OS. See docs for $mixer for details on
1643         arguments.
1644         <p></p>
1645 </td>
1646 </tr>
1647 <tr bgcolor="#b4cdcd">
1648 <td align="center">moc_album</td>
1649 <td align="center"></td>
1650 <td>Album of the current MOC song
1651         <p></p>
1652 </td>
1653 </tr>
1654 <tr bgcolor="#fffafa">
1655 <td align="center">moc_artist</td>
1656 <td align="center"></td>
1657 <td>Artist of the current MOC song
1658         <p></p>
1659 </td>
1660 </tr>
1661 <tr bgcolor="#b4cdcd">
1662 <td align="center">moc_bitrate</td>
1663 <td align="center"></td>
1664 <td>Bitrate in the current MOC song
1665         <p></p>
1666 </td>
1667 </tr>
1668 <tr bgcolor="#fffafa">
1669 <td align="center">moc_curtime</td>
1670 <td align="center"></td>
1671 <td>Current time of the current MOC song
1672         <p></p>
1673 </td>
1674 </tr>
1675 <tr bgcolor="#b4cdcd">
1676 <td align="center">moc_file</td>
1677 <td align="center"></td>
1678 <td>File name of the current MOC song
1679         <p></p>
1680 </td>
1681 </tr>
1682 <tr bgcolor="#fffafa">
1683 <td align="center">moc_rate</td>
1684 <td align="center"></td>
1685 <td>Rate of the current MOC song
1686         <p></p>
1687 </td>
1688 </tr>
1689 <tr bgcolor="#b4cdcd">
1690 <td align="center">moc_song</td>
1691 <td align="center"></td>
1692 <td>The current song name being played in MOC.
1693         <p></p>
1694 </td>
1695 </tr>
1696 <tr bgcolor="#fffafa">
1697 <td align="center">moc_state</td>
1698 <td align="center"></td>
1699 <td>Current state of MOC; playing, stopped etc.
1700         <p></p>
1701 </td>
1702 </tr>
1703 <tr bgcolor="#b4cdcd">
1704 <td align="center">moc_timeleft</td>
1705 <td align="center"></td>
1706 <td>Time left in the current MOC song
1707         <p></p>
1708 </td>
1709 </tr>
1710 <tr bgcolor="#fffafa">
1711 <td align="center">moc_title</td>
1712 <td align="center"></td>
1713 <td>Title of the current MOC song
1714         <p></p>
1715 </td>
1716 </tr>
1717 <tr bgcolor="#b4cdcd">
1718 <td align="center">moc_totaltime</td>
1719 <td align="center"></td>
1720 <td>Total length of the current MOC song
1721         <p></p>
1722 </td>
1723 </tr>
1724 <tr bgcolor="#fffafa">
1725 <td align="center">monitor</td>
1726 <td align="center"></td>
1727 <td>Number of the monitor on which conky is running
1728         or the message "Not running in X" if this is the case.
1729         <p></p>
1730 </td>
1731 </tr>
1732 <tr bgcolor="#b4cdcd">
1733 <td align="center">monitor_number</td>
1734 <td align="center"></td>
1735 <td>Number of monitors or the message "Not running in
1736         X" if this is the case.
1737         <p></p>
1738 </td>
1739 </tr>
1740 <tr bgcolor="#fffafa">
1741 <td align="center">mpd_album</td>
1742 <td align="center"></td>
1743 <td>Album in current MPD song
1744         <p></p>
1745 </td>
1746 </tr>
1747 <tr bgcolor="#b4cdcd">
1748 <td align="center">mpd_artist</td>
1749 <td align="center"></td>
1750 <td>Artist in current MPD song must be enabled at
1751         compile
1752         <p></p>
1753 </td>
1754 </tr>
1755 <tr bgcolor="#fffafa">
1756 <td align="center">mpd_bar</td>
1757 <td align="center">(height),(width)</td>
1758 <td>Bar of mpd's progress
1759         <p></p>
1760 </td>
1761 </tr>
1762 <tr bgcolor="#b4cdcd">
1763 <td align="center">mpd_bitrate</td>
1764 <td align="center"></td>
1765 <td>Bitrate of current song
1766         <p></p>
1767 </td>
1768 </tr>
1769 <tr bgcolor="#fffafa">
1770 <td align="center">mpd_elapsed</td>
1771 <td align="center"></td>
1772 <td>Song's elapsed time
1773         <p></p>
1774 </td>
1775 </tr>
1776 <tr bgcolor="#b4cdcd">
1777 <td align="center">mpd_file</td>
1778 <td align="center"></td>
1779 <td>Prints the file name of the current MPD song
1780         <p></p>
1781 </td>
1782 </tr>
1783 <tr bgcolor="#fffafa">
1784 <td align="center">mpd_length</td>
1785 <td align="center"></td>
1786 <td>Song's length
1787         <p></p>
1788 </td>
1789 </tr>
1790 <tr bgcolor="#b4cdcd">
1791 <td align="center">mpd_name</td>
1792 <td align="center"></td>
1793 <td>Prints the MPD name field
1794         <p></p>
1795 </td>
1796 </tr>
1797 <tr bgcolor="#fffafa">
1798 <td align="center">mpd_percent</td>
1799 <td align="center"></td>
1800 <td>Percent of song's progress
1801         <p></p>
1802 </td>
1803 </tr>
1804 <tr bgcolor="#b4cdcd">
1805 <td align="center">mpd_random</td>
1806 <td align="center"></td>
1807 <td>Random status (On/Off)
1808         <p></p>
1809 </td>
1810 </tr>
1811 <tr bgcolor="#fffafa">
1812 <td align="center">mpd_repeat</td>
1813 <td align="center"></td>
1814 <td>Repeat status (On/Off)
1815         <p></p>
1816 </td>
1817 </tr>
1818 <tr bgcolor="#b4cdcd">
1819 <td align="center">mpd_smart</td>
1820 <td align="center">(max length)</td>
1821 <td>Prints the song name in either the form "artist -
1822         title" or file name, depending on whats available
1823         <p></p>
1824 </td>
1825 </tr>
1826 <tr bgcolor="#fffafa">
1827 <td align="center">mpd_status</td>
1828 <td align="center"></td>
1829 <td>Playing, stopped, et cetera.
1830         <p></p>
1831 </td>
1832 </tr>
1833 <tr bgcolor="#b4cdcd">
1834 <td align="center">mpd_title</td>
1835 <td align="center">(max length)</td>
1836 <td>Title of current MPD song
1837         <p></p>
1838 </td>
1839 </tr>
1840 <tr bgcolor="#fffafa">
1841 <td align="center">mpd_track</td>
1842 <td align="center"></td>
1843 <td>Prints the MPD track field
1844         <p></p>
1845 </td>
1846 </tr>
1847 <tr bgcolor="#b4cdcd">
1848 <td align="center">mpd_vol</td>
1849 <td align="center"></td>
1850 <td>MPD's volume
1851         <p></p>
1852 </td>
1853 </tr>
1854 <tr bgcolor="#fffafa">
1855 <td align="center">nameserver</td>
1856 <td align="center">(index)</td>
1857 <td>Print a nameserver from /etc/resolv.conf. Index
1858         starts at and defaults to 0.
1859         <p></p>
1860 </td>
1861 </tr>
1862 <tr bgcolor="#b4cdcd">
1863 <td align="center">new_mails</td>
1864 <td align="center">(mailbox)</td>
1865 <td>Unread mail count in the specified mailbox or
1866         mail spool if not. Both mbox and maildir type mailboxes are
1867         supported.
1868         <p></p>
1869 </td>
1870 </tr>
1871 <tr bgcolor="#fffafa">
1872 <td align="center">nodename</td>
1873 <td align="center"></td>
1874 <td>Hostname
1875         <p></p>
1876 </td>
1877 </tr>
1878 <tr bgcolor="#b4cdcd">
1879 <td align="center">nvidia</td>
1880 <td align="center">threshold</td>
1881 <td>Nvidia graficcard support for the XNVCtrl
1882         library. Each option can be shortened to the least
1883         significant part. Temperatures are printed as float, all
1884         other values as integer.
1885         <ul>
1886 <li>
1887                 <strong>threshold</strong> -
1888
1889                 The thresholdtemperature at
1890                         which the gpu slows down
1891             </li>
1892 <li>
1893                 <strong>temp</strong> -
1894
1895                 Gives the gpu current
1896                         temperature
1897             </li>
1898 <li>
1899                 <strong>ambient</strong> -
1900
1901                 Gives current air temperature near GPU
1902                 case
1903             </li>
1904 <li>
1905                 <strong>gpufreq</strong> -
1906
1907                 Gives the current gpu frequency
1908             </li>
1909 <li>
1910                 <strong>memfreq</strong> -
1911
1912                 Gives the current mem frequency
1913             </li>
1914 <li>
1915                 <strong>imagequality</strong> -
1916
1917                 Which imagequality should be chosen by
1918                 OpenGL applications
1919             </li>
1920 </ul>
1921         <p></p>
1922 </td>
1923 </tr>
1924 <tr bgcolor="#fffafa">
1925 <td align="center">offset</td>
1926 <td align="center">(pixels)</td>
1927 <td>Move text over by N pixels. See also $voffset.
1928         <p></p>
1929 </td>
1930 </tr>
1931 <tr bgcolor="#b4cdcd">
1932 <td align="center">outlinecolor</td>
1933 <td align="center">(color)</td>
1934 <td>Change outline color
1935         <p></p>
1936 </td>
1937 </tr>
1938 <tr bgcolor="#fffafa">
1939 <td align="center">pb_battery</td>
1940 <td align="center">item</td>
1941 <td>If running on Apple powerbook/ibook, display
1942         information on battery status. The item parameter
1943         specifies, what information to display. Exactly one item
1944         must be specified. Valid items are:
1945         <ul>
1946 <li>
1947                 <strong>status</strong> -
1948
1949                 Display if battery is fully charged,
1950                 charging, discharging or absent (running on
1951                 AC)
1952             </li>
1953 <li>
1954                 <strong>percent</strong> -
1955
1956                 Display charge of battery in percent, if
1957                 charging or discharging. Nothing will be displayed,
1958                 if battery is fully charged or absent.
1959             </li>
1960 <li>
1961                 <strong>time</strong> -
1962
1963                 Display the time remaining until the
1964                 battery will be fully charged or discharged at
1965                 current rate. Nothing is displayed, if battery is
1966                 absent or if it's present but fully charged and not
1967                 discharging.
1968             </li>
1969 </ul>
1970         <p></p>
1971 </td>
1972 </tr>
1973 <tr bgcolor="#b4cdcd">
1974 <td align="center">pid_chroot</td>
1975 <td align="center">pid</td>
1976 <td>Directory used as rootdirectory by the process
1977         (this will be "/" unless the process did a chroot syscall)
1978         <p></p>
1979 </td>
1980 </tr>
1981 <tr bgcolor="#fffafa">
1982 <td align="center">pid_cmdline</td>
1983 <td align="center">pid</td>
1984 <td>Command line this process was invoked with
1985         <p></p>
1986 </td>
1987 </tr>
1988 <tr bgcolor="#b4cdcd">
1989 <td align="center">pid_cwd</td>
1990 <td align="center">pid</td>
1991 <td>Current working directory of the process
1992         <p></p>
1993 </td>
1994 </tr>
1995 <tr bgcolor="#fffafa">
1996 <td align="center">pid_environ</td>
1997 <td align="center">pid varname</td>
1998 <td>Contents of a environment-var of the process
1999         <p></p>
2000 </td>
2001 </tr>
2002 <tr bgcolor="#b4cdcd">
2003 <td align="center">pid_environ_list</td>
2004 <td align="center">pid</td>
2005 <td>List of environment-vars that the process can see
2006         <p></p>
2007 </td>
2008 </tr>
2009 <tr bgcolor="#fffafa">
2010 <td align="center">pid_exe</td>
2011 <td align="center">pid</td>
2012 <td>Path to executed command that started the process
2013         <p></p>
2014 </td>
2015 </tr>
2016 <tr bgcolor="#b4cdcd">
2017 <td align="center">pid_nice</td>
2018 <td align="center">pid</td>
2019 <td>The nice value of the process
2020         <p></p>
2021 </td>
2022 </tr>
2023 <tr bgcolor="#fffafa">
2024 <td align="center">pid_openfiles</td>
2025 <td align="center">pid</td>
2026 <td>List of files that the process has open
2027         <p></p>
2028 </td>
2029 </tr>
2030 <tr bgcolor="#b4cdcd">
2031 <td align="center">pid_parent</td>
2032 <td align="center">pid</td>
2033 <td>The pid of the parent of the process
2034         <p></p>
2035 </td>
2036 </tr>
2037 <tr bgcolor="#fffafa">
2038 <td align="center">pid_priority</td>
2039 <td align="center">pid</td>
2040 <td>The priority of the process (see 'priority' in "man 5 proc")
2041         <p></p>
2042 </td>
2043 </tr>
2044 <tr bgcolor="#b4cdcd">
2045 <td align="center">pid_read</td>
2046 <td align="center">pid</td>
2047 <td>Total number of bytes read by the process
2048         <p></p>
2049 </td>
2050 </tr>
2051 <tr bgcolor="#fffafa">
2052 <td align="center">pid_state</td>
2053 <td align="center">pid</td>
2054 <td>State of the process
2055         <p></p>
2056 </td>
2057 </tr>
2058 <tr bgcolor="#b4cdcd">
2059 <td align="center">pid_state_short</td>
2060 <td align="center">pid</td>
2061 <td>One of the chars in "RSDZTW" representing the state
2062         of the process where R is running, S is sleeping in an
2063         interruptible wait, D is waiting in uninterruptible disk sleep,
2064         Z is zombie, T is traced or stopped (on a signal), and W is paging
2065         <p></p>
2066 </td>
2067 </tr>
2068 <tr bgcolor="#fffafa">
2069 <td align="center">pid_stderr</td>
2070 <td align="center">pid</td>
2071 <td>Filedescriptor binded to the STDERR of the process
2072         <p></p>
2073 </td>
2074 </tr>
2075 <tr bgcolor="#b4cdcd">
2076 <td align="center">pid_stdin</td>
2077 <td align="center">pid</td>
2078 <td>Filedescriptor binded to the STDIN of the process
2079         <p></p>
2080 </td>
2081 </tr>
2082 <tr bgcolor="#fffafa">
2083 <td align="center">pid_stdout</td>
2084 <td align="center">pid</td>
2085 <td>Filedescriptor binded to the STDOUT of the process
2086         <p></p>
2087 </td>
2088 </tr>
2089 <tr bgcolor="#b4cdcd">
2090 <td align="center">pid_threads</td>
2091 <td align="center">pid</td>
2092 <td>Number of threads in process containing this thread
2093         <p></p>
2094 </td>
2095 </tr>
2096 <tr bgcolor="#fffafa">
2097 <td align="center">pid_thread_list</td>
2098 <td align="center">pid</td>
2099 <td>List with pid's from threads from this process
2100         <p></p>
2101 </td>
2102 </tr>
2103 <tr bgcolor="#b4cdcd">
2104 <td align="center">pid_time_kernelmode</td>
2105 <td align="center">pid</td>
2106 <td>Amount of time that the process has been scheduled in kernel mode in seconds
2107         <p></p>
2108 </td>
2109 </tr>
2110 <tr bgcolor="#fffafa">
2111 <td align="center">pid_time_usermode</td>
2112 <td align="center">pid</td>
2113 <td>Amount of time that the process has been scheduled in user mode in seconds
2114         <p></p>
2115 </td>
2116 </tr>
2117 <tr bgcolor="#b4cdcd">
2118 <td align="center">pid_time</td>
2119 <td align="center">pid</td>
2120 <td>Sum of $pid_time_kernelmode and $pid_time_usermode
2121         <p></p>
2122 </td>
2123 </tr>
2124 <tr bgcolor="#fffafa">
2125 <td align="center">pid_uid</td>
2126 <td align="center">pid</td>
2127 <td>The real uid of the process
2128         <p></p>
2129 </td>
2130 </tr>
2131 <tr bgcolor="#b4cdcd">
2132 <td align="center">pid_euid</td>
2133 <td align="center">pid</td>
2134 <td>The effective uid of the process
2135         <p></p>
2136 </td>
2137 </tr>
2138 <tr bgcolor="#fffafa">
2139 <td align="center">pid_suid</td>
2140 <td align="center">pid</td>
2141 <td>The saved set uid of the process
2142         <p></p>
2143 </td>
2144 </tr>
2145 <tr bgcolor="#b4cdcd">
2146 <td align="center">pid_fsuid</td>
2147 <td align="center">pid</td>
2148 <td>The file system uid of the process
2149         <p></p>
2150 </td>
2151 </tr>
2152 <tr bgcolor="#fffafa">
2153 <td align="center">pid_gid</td>
2154 <td align="center">pid</td>
2155 <td>The real gid of the process
2156         <p></p>
2157 </td>
2158 </tr>
2159 <tr bgcolor="#b4cdcd">
2160 <td align="center">pid_egid</td>
2161 <td align="center">pid</td>
2162 <td>The effective gid of the process
2163         <p></p>
2164 </td>
2165 </tr>
2166 <tr bgcolor="#fffafa">
2167 <td align="center">pid_sgid</td>
2168 <td align="center">pid</td>
2169 <td>The saved set gid of the process
2170         <p></p>
2171 </td>
2172 </tr>
2173 <tr bgcolor="#b4cdcd">
2174 <td align="center">pid_fsgid</td>
2175 <td align="center">pid</td>
2176 <td>The file system gid of the process
2177         <p></p>
2178 </td>
2179 </tr>
2180 <tr bgcolor="#fffafa">
2181 <td align="center">pid_vmpeak</td>
2182 <td align="center">pid</td>
2183 <td>Peak virtual memory size of the process
2184         <p></p>
2185 </td>
2186 </tr>
2187 <tr bgcolor="#b4cdcd">
2188 <td align="center">pid_vmsize</td>
2189 <td align="center">pid</td>
2190 <td>Virtual memory size of the process
2191         <p></p>
2192 </td>
2193 </tr>
2194 <tr bgcolor="#fffafa">
2195 <td align="center">pid_vmlck</td>
2196 <td align="center">pid</td>
2197 <td>Locked memory size of the process
2198         <p></p>
2199 </td>
2200 </tr>
2201 <tr bgcolor="#b4cdcd">
2202 <td align="center">pid_vmhwm</td>
2203 <td align="center">pid</td>
2204 <td>Peak resident set size ("high water mark") of the process
2205         <p></p>
2206 </td>
2207 </tr>
2208 <tr bgcolor="#fffafa">
2209 <td align="center">pid_vmrss</td>
2210 <td align="center">pid</td>
2211 <td>Resident set size of the process
2212         <p></p>
2213 </td>
2214 </tr>
2215 <tr bgcolor="#b4cdcd">
2216 <td align="center">pid_vmdata</td>
2217 <td align="center">pid</td>
2218 <td>Data segment size of the process
2219         <p></p>
2220 </td>
2221 </tr>
2222 <tr bgcolor="#fffafa">
2223 <td align="center">pid_vmstk</td>
2224 <td align="center">pid</td>
2225 <td>Stack segment size of the process
2226         <p></p>
2227 </td>
2228 </tr>
2229 <tr bgcolor="#b4cdcd">
2230 <td align="center">pid_vmexe</td>
2231 <td align="center">pid</td>
2232 <td>Text segment size of the process
2233         <p></p>
2234 </td>
2235 </tr>
2236 <tr bgcolor="#fffafa">
2237 <td align="center">pid_vmlib</td>
2238 <td align="center">pid</td>
2239 <td>Shared library code size of the process
2240         <p></p>
2241 </td>
2242 </tr>
2243 <tr bgcolor="#b4cdcd">
2244 <td align="center">pid_vmpte</td>
2245 <td align="center">pid</td>
2246 <td>Page table entries size of the process
2247         <p></p>
2248 </td>
2249 </tr>
2250 <tr bgcolor="#fffafa">
2251 <td align="center">pid_write</td>
2252 <td align="center">pid</td>
2253 <td>Total number of bytes written by the process
2254         <p></p>
2255 </td>
2256 </tr>
2257 <tr bgcolor="#b4cdcd">
2258 <td align="center">platform</td>
2259 <td align="center">(dev) type n (factor offset)</td>
2260 <td>Platform sensor from sysfs (Linux 2.6). Parameter
2261         dev may be omitted if you have only one platform device.
2262         Platform type is either 'in' or 'vol' meaning voltage;
2263         'fan' meaning fan; 'temp' meaning temperature. Parameter n
2264         is number of the sensor. See /sys/bus/platform/devices/ on
2265         your local computer. The optional arguments 'factor' and
2266         'offset' allow precalculation of the raw input, which is
2267         being modified as follows: 'input = input * factor +
2268         offset'. Note that they have to be given as decimal values
2269         (i.e. contain at least one decimal place).
2270         <p></p>
2271 </td>
2272 </tr>
2273 <tr bgcolor="#fffafa">
2274 <td align="center">pop3_unseen</td>
2275 <td align="center">(args)</td>
2276 <td>Displays the number of unseen messages in your
2277         global POP3 inbox by default. You can define individual
2278         POP3 inboxes separately by passing arguments to this
2279         object. Arguments are: "host user pass [-i interval (in
2280         seconds)] [-p port] [-e 'command'] [-r retries]". Default
2281         port is 110, default interval is 5 minutes, and default
2282         number of retries before giving up is 5. If the password is
2283         supplied as '*', you will be prompted to enter the password
2284         when Conky starts.
2285         <p></p>
2286 </td>
2287 </tr>
2288 <tr bgcolor="#b4cdcd">
2289 <td align="center">pop3_used</td>
2290 <td align="center">(args)</td>
2291 <td>Displays the amount of space (in MiB, 2^20) used
2292         in your global POP3 inbox by default. You can define
2293         individual POP3 inboxes separately by passing arguments to
2294         this object. Arguments are: "host user pass [-i interval
2295         (in seconds)] [-p port] [-e 'command'] [-r retries]". Default
2296         port is 110, default interval is 5 minutes, and default
2297         number of retries before giving up is 5. If the password is
2298         supplied as '*', you will be prompted to enter the password
2299         when Conky starts.
2300         <p></p>
2301 </td>
2302 </tr>
2303 <tr bgcolor="#fffafa">
2304 <td align="center">pre_exec</td>
2305 <td align="center">shell command</td>
2306 <td>Executes a shell command one time before conky
2307         displays anything and puts output as text.
2308         <p></p>
2309 </td>
2310 </tr>
2311 <tr bgcolor="#b4cdcd">
2312 <td align="center">processes</td>
2313 <td align="center"></td>
2314 <td>Total processes (sleeping and running)
2315         <p></p>
2316 </td>
2317 </tr>
2318 <tr bgcolor="#fffafa">
2319 <td align="center">read_tcp</td>
2320 <td align="center">(host) port</td>
2321 <td>Connects to a tcp port on a host (default is
2322         localhost), reads every char available at the moment and
2323         shows them.
2324         <p></p>
2325 </td>
2326 </tr>
2327 <tr bgcolor="#b4cdcd">
2328 <td align="center">replied_mails</td>
2329 <td align="center">(maildir)</td>
2330 <td>Number of mails marked as replied in the
2331         specified mailbox or mail spool if not. Only maildir type
2332         mailboxes are supported, mbox type will return -1.
2333         <p></p>
2334 </td>
2335 </tr>
2336 <tr bgcolor="#fffafa">
2337 <td align="center">rss</td>
2338 <td align="center">uri interval_in_minutes action (num_par
2339             (spaces_in_front))</td>
2340 <td>
2341             <p>Download and parse RSS feeds. The interval may be
2342             a floating point value greater than 0, otherwise
2343             defaults to 15 minutes. Action may be one of the
2344             following: feed_title, item_title (with num par),
2345             item_desc (with num par) and item_titles (when using
2346             this action and spaces_in_front is given conky places
2347             that many spaces in front of each item). This object is
2348             threaded, and once a thread is created it can't be
2349             explicitly destroyed. One thread will run for each URI
2350             specified. You can use any protocol that Curl
2351             supports.</p>
2352         </td>
2353 </tr>
2354 <tr bgcolor="#b4cdcd">
2355 <td align="center">running_processes</td>
2356 <td align="center"></td>
2357 <td>Running processes (not sleeping), requires Linux
2358         2.6
2359         <p></p>
2360 </td>
2361 </tr>
2362 <tr bgcolor="#fffafa">
2363 <td align="center">running_threads</td>
2364 <td align="center"></td>
2365 <td>Number of running (runnable) threads. Linux only.
2366         <p></p>
2367 </td>
2368 </tr>
2369 <tr bgcolor="#b4cdcd">
2370 <td align="center">scroll</td>
2371 <td align="center">length (step) text</td>
2372 <td>Scroll 'text' by 'step' characters showing
2373         'length' number of characters at the same time. The text
2374         may also contain variables. 'step' is optional and defaults
2375         to 1 if not set. If a var creates output on multiple lines
2376         then the lines are placed behind each other separated with
2377         a '|'-sign. If you change the textcolor inside $scroll it
2378         will automatically have it's old value back at the end of
2379         $scroll. The end and the start of text will be separated by
2380         'length' number of spaces.
2381         <p></p>
2382 </td>
2383 </tr>
2384 <tr bgcolor="#fffafa">
2385 <td align="center">seen_mails</td>
2386 <td align="center">(maildir)</td>
2387 <td>Number of mails marked as seen in the specified
2388         mailbox or mail spool if not. Only maildir type mailboxes
2389         are supported, mbox type will return -1.
2390         <p></p>
2391 </td>
2392 </tr>
2393 <tr bgcolor="#b4cdcd">
2394 <td align="center">shadecolor</td>
2395 <td align="center">(color)</td>
2396 <td>Change shading color
2397         <p></p>
2398 </td>
2399 </tr>
2400 <tr bgcolor="#fffafa">
2401 <td align="center">smapi</td>
2402 <td align="center">(ARGS)</td>
2403 <td>when using smapi, display contents of the
2404         /sys/devices/platform/smapi directory. ARGS are either
2405         '(FILENAME)' or 'bat (INDEX) (FILENAME)' to display the
2406         corresponding files' content. This is a very raw method of
2407         accessing the smapi values. When available, better use one
2408         of the smapi_* variables instead.
2409         <p></p>
2410 </td>
2411 </tr>
2412 <tr bgcolor="#b4cdcd">
2413 <td align="center">smapi_bat_bar</td>
2414 <td align="center">(INDEX),(height),(width)</td>
2415 <td>when using smapi, display the remaining capacity
2416         of the battery with index INDEX as a bar.
2417         <p></p>
2418 </td>
2419 </tr>
2420 <tr bgcolor="#fffafa">
2421 <td align="center">smapi_bat_perc</td>
2422 <td align="center">(INDEX)</td>
2423 <td>when using smapi, display the remaining capacity
2424         in percent of the battery with index INDEX. This is a
2425         separate variable because it supports the 'use_spacer'
2426         configuration option.
2427         <p></p>
2428 </td>
2429 </tr>
2430 <tr bgcolor="#b4cdcd">
2431 <td align="center">smapi_bat_power</td>
2432 <td align="center">INDEX</td>
2433 <td>when using smapi, display the current power of
2434         the battery with index INDEX in watt. This is a separate
2435         variable because the original read out value is being
2436         converted from mW. The sign of the output reflects charging
2437         (positive) or discharging (negative) state.
2438         <p></p>
2439 </td>
2440 </tr>
2441 <tr bgcolor="#fffafa">
2442 <td align="center">smapi_bat_temp</td>
2443 <td align="center">INDEX</td>
2444 <td>when using smapi, display the current temperature
2445         of the battery with index INDEX in degree Celsius. This is
2446         a separate variable because the original read out value is
2447         being converted from milli degree Celsius.
2448         <p></p>
2449 </td>
2450 </tr>
2451 <tr bgcolor="#b4cdcd">
2452 <td align="center">sony_fanspeed</td>
2453 <td align="center"></td>
2454 <td>Displays the Sony VAIO fanspeed information if
2455         sony-laptop kernel support is enabled. Linux only.
2456         <p></p>
2457 </td>
2458 </tr>
2459 <tr bgcolor="#fffafa">
2460 <td align="center">stippled_hr</td>
2461 <td align="center">(space)</td>
2462 <td>Stippled (dashed) horizontal line
2463         <p></p>
2464 </td>
2465 </tr>
2466 <tr bgcolor="#b4cdcd">
2467 <td align="center">swap</td>
2468 <td align="center"></td>
2469 <td>Amount of swap in use
2470         <p></p>
2471 </td>
2472 </tr>
2473 <tr bgcolor="#fffafa">
2474 <td align="center">swapbar</td>
2475 <td align="center">(height),(width)</td>
2476 <td>Bar that shows amount of swap in use
2477         <p></p>
2478 </td>
2479 </tr>
2480 <tr bgcolor="#b4cdcd">
2481 <td align="center">swapfree</td>
2482 <td align="center"></td>
2483 <td>Amount of free swap
2484         <p></p>
2485 </td>
2486 </tr>
2487 <tr bgcolor="#fffafa">
2488 <td align="center">swapmax</td>
2489 <td align="center"></td>
2490 <td>Total amount of swap
2491         <p></p>
2492 </td>
2493 </tr>
2494 <tr bgcolor="#b4cdcd">
2495 <td align="center">swapperc</td>
2496 <td align="center"></td>
2497 <td>Percentage of swap in use
2498         <p></p>
2499 </td>
2500 </tr>
2501 <tr bgcolor="#fffafa">
2502 <td align="center">sysname</td>
2503 <td align="center"></td>
2504 <td>System name, Linux for example
2505         <p></p>
2506 </td>
2507 </tr>
2508 <tr bgcolor="#b4cdcd">
2509 <td align="center">tab</td>
2510 <td align="center">(width, (start))</td>
2511 <td>Puts a tab of the specified width, starting from
2512         column 'start'. The unit is pixels for both arguments.
2513         <p></p>
2514 </td>
2515 </tr>
2516 <tr bgcolor="#fffafa">
2517 <td align="center">tail</td>
2518 <td align="center">logfile lines (next_check)</td>
2519 <td>Displays last N lines of supplied text file. The
2520         file is checked every 'next_check' update. If next_check is
2521         not supplied, Conky defaults to 2. Max of 30 lines can be
2522         displayed, or until the text buffer is filled.
2523         <p></p>
2524 </td>
2525 </tr>
2526 <tr bgcolor="#b4cdcd">
2527 <td align="center">tcp_portmon</td>
2528 <td align="center">port_begin port_end item (index)</td>
2529 <td>
2530             <p>TCP port (both IPv6 and IPv4) monitor for
2531             specified local ports. Port numbers must be in
2532             the range 1 to 65535. Valid items are:</p>
2533             <ul>
2534 <li>
2535                     <strong>count</strong> -
2536
2537                     Total number of connections in the
2538                     range
2539                 </li>
2540 <li>
2541                     <strong>rip</strong> -
2542
2543                     Remote ip address
2544                 </li>
2545 <li>
2546                     <strong>rhost</strong> -
2547
2548                     Remote host name
2549                 </li>
2550 <li>
2551                     <strong>rport</strong> -
2552
2553                     Remote port number
2554                 </li>
2555 <li>
2556                     <strong>rservice</strong> -
2557
2558                     Remote service name from
2559                     /etc/services
2560                 </li>
2561 <li>
2562                     <strong>lip</strong> -
2563
2564                     Local ip address
2565                 </li>
2566 <li>
2567                     <strong>lhost</strong> -
2568
2569                     Local host name
2570                 </li>
2571 <li>
2572                     <strong>lport</strong> -
2573
2574                     Local port number
2575                 </li>
2576 <li>
2577                     <strong>lservice</strong> -
2578
2579                     Local service name from
2580                     /etc/services
2581                 </li>
2582 </ul>
2583             <p>The connection index provides you with access to
2584             each connection in the port monitor. The monitor will
2585             return information for index values from 0 to n-1
2586             connections. Values higher than n-1 are simply ignored.
2587             For the "count" item, the connection index must be
2588             omitted. It is required for all other items.</p>
2589             <p>Examples:</p>
2590             <ul>
2591 <li>
2592                     <strong>${tcp_portmon 6881 6999
2593                     count}</strong> -
2594
2595                     Displays the number of connections in
2596                     the bittorrent port range
2597                 </li>
2598 <li>
2599                     <strong>${tcp_portmon 22 22 rip 0}</strong> -
2600
2601                     Displays the remote host ip of the
2602                     first sshd connection
2603                 </li>
2604 <li>
2605                     <strong>${tcp_portmon 22 22 rip 9}</strong> -
2606
2607                     Displays the remote host ip of the
2608                     tenth sshd connection
2609                 </li>
2610 <li>
2611                     <strong>${tcp_portmon 1 1024 rhost
2612                     0}</strong> -
2613
2614                     Displays the remote host name of the
2615                     first connection on a privileged port
2616                 </li>
2617 <li>
2618                     <strong>${tcp_portmon 1 1024 rport
2619                     4}</strong> -
2620
2621                     Displays the remote host port of the
2622                     fifth connection on a privileged port
2623                 </li>
2624 <li>
2625                     <strong>${tcp_portmon 1 65535 lservice
2626                     14}</strong> -
2627
2628                     Displays the local service name of the
2629                     fifteenth connection in the range of all
2630                     ports
2631                 </li>
2632 </ul>
2633             <p>Note that port monitor variables which share the
2634             same port range actually refer to the same monitor, so
2635             many references to a single port range for different
2636             items and different indexes all use the same monitor
2637             internally. In other words, the program avoids creating
2638             redundant monitors.</p>
2639         </td>
2640 </tr>
2641 <tr bgcolor="#fffafa">
2642 <td align="center">templateN</td>
2643 <td align="center">(arg1)</td>
2644 <td>
2645             <p>Evaluate the content of the templateN
2646             configuration variable (where N is a value between 0
2647             and 9, inclusively), applying substitutions as
2648             described in the documentation of the corresponding
2649             configuration variable. The number of arguments is
2650             optional, but must match the highest referred index in
2651             the template. You can use the same special sequences in
2652             each argument as the ones valid for a template
2653             definition, e.g. to allow an argument to contain a
2654             whitespace. Also simple nesting of templates is
2655             possible this way.</p>
2656             <p>Here are some examples of template
2657             definitions:</p>
2658             <ul>
2659 <li>template0 $\1\2</li>
2660 <li>template1 \1: ${fs_used \2} / ${fs_size
2661                 \2}</li>
2662 <li>template2 \1 \2</li>
2663 </ul>
2664             <p>The following list shows sample usage of the
2665             templates defined above, with the equivalent syntax
2666             when not using any template at all:</p>
2667
2668
2669
2670
2671                             using template
2672                             same without template
2673
2674
2675
2676
2677                             ${template0 node name}
2678                             $nodename
2679
2680
2681                             ${template1 root /}
2682                             root: ${fs_free /} / ${fs_size
2683                             /}
2684
2685
2686
2687                                 ${template1
2688                                 ${template2\ disk\ root}
2689                                 /}
2690
2691
2692                                 disk root:
2693                                 ${fs_free /} / ${fs_size
2694                                 /}
2695
2696
2697
2698
2699
2700         </td>
2701 </tr>
2702 <tr bgcolor="#b4cdcd">
2703 <td align="center">texeci</td>
2704 <td align="center">interval command</td>
2705 <td>Runs a command at an interval inside a thread and
2706         displays the output. Same as $execi, except the command is
2707         run inside a thread. Use this if you have a slow script to
2708         keep Conky updating. You should make the interval slightly
2709         longer then the time it takes your script to execute. For
2710         example, if you have a script that take 5 seconds to
2711         execute, you should make the interval at least 6 seconds.
2712         See also $execi. This object will clean up the thread when
2713         it is destroyed, so it can safely be used in a nested
2714         fashion, though it may not produce the desired behaviour if
2715         used this way.
2716         <p></p>
2717 </td>
2718 </tr>
2719 <tr bgcolor="#fffafa">
2720 <td align="center">threads</td>
2721 <td align="center"></td>
2722 <td>Total threads
2723         <p></p>
2724 </td>
2725 </tr>
2726 <tr bgcolor="#b4cdcd">
2727 <td align="center">time</td>
2728 <td align="center">(format)</td>
2729 <td>Local time, see man strftime to get more
2730         information about format
2731         <p></p>
2732 </td>
2733 </tr>
2734 <tr bgcolor="#fffafa">
2735 <td align="center">to_bytes</td>
2736 <td align="center">size</td>
2737 <td>If 'size' is a number followed by a size-unit
2738         (kilobyte,mb,GiB,...) then it converts the size to bytes
2739         and shows it without unit, otherwise it just shows 'size'.
2740         <p></p>
2741 </td>
2742 </tr>
2743 <tr bgcolor="#b4cdcd">
2744 <td align="center">top</td>
2745 <td align="center">type num</td>
2746 <td>This takes arguments in the form:top (name)
2747         (number) Basically, processes are ranked from highest to
2748         lowest in terms of cpu usage, which is what (num)
2749         represents. The types are: "name", "pid", "cpu", "mem",
2750         "mem_res", "mem_vsize", "time", "io_perc", "io_read" and
2751         "io_write". There can be a max of 10 processes listed.
2752         <p></p>
2753 </td>
2754 </tr>
2755 <tr bgcolor="#fffafa">
2756 <td align="center">top_io</td>
2757 <td align="center">type num</td>
2758 <td>Same as top, except sorted by the amount of I/O
2759         the process has done during the update interval
2760         <p></p>
2761 </td>
2762 </tr>
2763 <tr bgcolor="#b4cdcd">
2764 <td align="center">top_mem</td>
2765 <td align="center">type num</td>
2766 <td>Same as top, except sorted by mem usage instead
2767         of cpu
2768         <p></p>
2769 </td>
2770 </tr>
2771 <tr bgcolor="#fffafa">
2772 <td align="center">top_time</td>
2773 <td align="center">type num</td>
2774 <td>Same as top, except sorted by total CPU time
2775         instead of current CPU usage
2776         <p></p>
2777 </td>
2778 </tr>
2779 <tr bgcolor="#b4cdcd">
2780 <td align="center">totaldown</td>
2781 <td align="center">(net)</td>
2782 <td>Total download, overflows at 4 GB on Linux with
2783         32-bit arch and there doesn't seem to be a way to know how
2784         many times it has already done that before conky has
2785         started.
2786         <p></p>
2787 </td>
2788 </tr>
2789 <tr bgcolor="#fffafa">
2790 <td align="center">totalup</td>
2791 <td align="center">(net)</td>
2792 <td>Total upload, this one too, may overflow
2793         <p></p>
2794 </td>
2795 </tr>
2796 <tr bgcolor="#b4cdcd">
2797 <td align="center">trashed_mails</td>
2798 <td align="center">(maildir)</td>
2799 <td>Number of mails marked as trashed in the
2800         specified mailbox or mail spool if not. Only maildir type
2801         mailboxes are supported, mbox type will return -1.
2802         <p></p>
2803 </td>
2804 </tr>
2805 <tr bgcolor="#fffafa">
2806 <td align="center">tztime</td>
2807 <td align="center">(timezone (format))</td>
2808 <td>Local time for specified timezone, see man
2809         strftime to get more information about format. The timezone
2810         argument is specified in similar fashion as TZ environment
2811         variable. For hints, look in /usr/share/zoneinfo. e.g.
2812         US/Pacific, Europe/Zurich, etc.
2813         <p></p>
2814 </td>
2815 </tr>
2816 <tr bgcolor="#b4cdcd">
2817 <td align="center">gid_name</td>
2818 <td align="center">gid</td>
2819 <td>Name of group with this gid
2820         <p></p>
2821 </td>
2822 </tr>
2823 <tr bgcolor="#fffafa">
2824 <td align="center">uid_name</td>
2825 <td align="center">uid</td>
2826 <td>Username of user with this uid
2827         <p></p>
2828 </td>
2829 </tr>
2830 <tr bgcolor="#b4cdcd">
2831 <td align="center">unflagged_mails</td>
2832 <td align="center">(maildir)</td>
2833 <td>Number of mails not marked as flagged in the
2834         specified mailbox or mail spool if not. Only maildir type
2835         mailboxes are supported, mbox type will return -1.
2836         <p></p>
2837 </td>
2838 </tr>
2839 <tr bgcolor="#fffafa">
2840 <td align="center">unforwarded_mails</td>
2841 <td align="center">(maildir)</td>
2842 <td>Number of mails not marked as forwarded in the
2843         specified mailbox or mail spool if not. Only maildir type
2844         mailboxes are supported, mbox type will return -1.
2845         <p></p>
2846 </td>
2847 </tr>
2848 <tr bgcolor="#b4cdcd">
2849 <td align="center">unreplied_mails</td>
2850 <td align="center">(maildir)</td>
2851 <td>Number of mails not marked as replied in the
2852         specified mailbox or mail spool if not. Only maildir type
2853         mailboxes are supported, mbox type will return -1.
2854         <p></p>
2855 </td>
2856 </tr>
2857 <tr bgcolor="#fffafa">
2858 <td align="center">unseen_mails</td>
2859 <td align="center">(maildir)</td>
2860 <td>Number of new or unseen mails in the specified
2861         mailbox or mail spool if not. Only maildir type mailboxes
2862         are supported, mbox type will return -1.
2863         <p></p>
2864 </td>
2865 </tr>
2866 <tr bgcolor="#b4cdcd">
2867 <td align="center">updates</td>
2868 <td align="center">Number of updates</td>
2869 <td>for debugging
2870         <p></p>
2871 </td>
2872 </tr>
2873 <tr bgcolor="#fffafa">
2874 <td align="center">upspeed</td>
2875 <td align="center">(net)</td>
2876 <td>Upload speed in suitable IEC units
2877         <p></p>
2878 </td>
2879 </tr>
2880 <tr bgcolor="#b4cdcd">
2881 <td align="center">upspeedf</td>
2882 <td align="center">(net)</td>
2883 <td>Upload speed in KiB with one decimal
2884         <p></p>
2885 </td>
2886 </tr>
2887 <tr bgcolor="#fffafa">
2888 <td align="center">upspeedgraph</td>
2889 <td align="center">(netdev) (height),(width) (gradient colour 1)
2890             (gradient colour 2) (scale) (-t) (-l)</td>
2891 <td>Upload speed graph, colours defined in hex, minus
2892         the #. If scale is non-zero, it becomes the scale for the
2893         graph. Uses a logarithmic scale (to see small numbers) when
2894         you use the -l switch. Takes the switch '-t' to use a
2895         temperature gradient, which makes the gradient values
2896         change depending on the amplitude of a particular graph
2897         value (try it and see).
2898         <p></p>
2899 </td>
2900 </tr>
2901 <tr bgcolor="#b4cdcd">
2902 <td align="center">uptime</td>
2903 <td align="center"></td>
2904 <td>Uptime
2905         <p></p>
2906 </td>
2907 </tr>
2908 <tr bgcolor="#fffafa">
2909 <td align="center">uptime_short</td>
2910 <td align="center"></td>
2911 <td>Uptime in a shorter format
2912         <p></p>
2913 </td>
2914 </tr>
2915 <tr bgcolor="#b4cdcd">
2916 <td align="center">user_names</td>
2917 <td align="center"></td>
2918 <td>Lists the names of the users logged in
2919         <p></p>
2920 </td>
2921 </tr>
2922 <tr bgcolor="#fffafa">
2923 <td align="center">user_number</td>
2924 <td align="center"></td>
2925 <td>Number of users logged in
2926         <p></p>
2927 </td>
2928 </tr>
2929 <tr bgcolor="#b4cdcd">
2930 <td align="center">user_terms</td>
2931 <td align="center"></td>
2932 <td>Lists the consoles in use
2933         <p></p>
2934 </td>
2935 </tr>
2936 <tr bgcolor="#fffafa">
2937 <td align="center">user_times</td>
2938 <td align="center"></td>
2939 <td>Lists how long users have been logged in for
2940         <p></p>
2941 </td>
2942 </tr>
2943 <tr bgcolor="#b4cdcd">
2944 <td align="center">user_time</td>
2945 <td align="center">console</td>
2946 <td>Lists how long the user for the given console has been
2947         logged in for
2948         <p></p>
2949 </td>
2950 </tr>
2951 <tr bgcolor="#fffafa">
2952 <td align="center">utime</td>
2953 <td align="center">(format)</td>
2954 <td>Display time in UTC (universal coordinate time).
2955         <p></p>
2956 </td>
2957 </tr>
2958 <tr bgcolor="#b4cdcd">
2959 <td align="center">voffset</td>
2960 <td align="center">(pixels)</td>
2961 <td>Change vertical offset by N pixels. Negative
2962         values will cause text to overlap. See also $offset.
2963         <p></p>
2964 </td>
2965 </tr>
2966 <tr bgcolor="#fffafa">
2967 <td align="center">voltage_mv</td>
2968 <td align="center">(n)</td>
2969 <td>Returns CPU #n's voltage in mV. CPUs are counted
2970         from 1. If omitted, the parameter defaults to 1.
2971         <p></p>
2972 </td>
2973 </tr>
2974 <tr bgcolor="#b4cdcd">
2975 <td align="center">voltage_v</td>
2976 <td align="center">(n)</td>
2977 <td>Returns CPU #n's voltage in V. CPUs are counted
2978         from 1. If omitted, the parameter defaults to 1.
2979         <p></p>
2980 </td>
2981 </tr>
2982 <tr bgcolor="#fffafa">
2983 <td align="center">weather</td>
2984 <td align="center">URI locID data_type
2985             (interval_in_minutes)</td>
2986 <td>
2987             <p>Download, parse and display METAR data.</p>
2988             <p>For the 'URI', there are two
2989             possibilities:</p>
2990             <ul>
2991 <li>
2992                 http://weather.noaa.gov/pub/data/observations/metar/stations/</li>
2993 <li>
2994                 http://xoap.weather.com/weather/local/</li>
2995 </ul>
2996             <p>The first one is free to use but the second
2997             requires you to register and obtain your partner ID and
2998             license key. These two must be written, separated by a
2999             space, into a file called .xoaprc which needs to be
3000             placed into your home directory.</p>
3001             <p>'locID' must be a valid location identifier for
3002             the required uri. For the NOAA site this must be a
3003             valid ICAO (see for instance
3004             https://pilotweb.nas.faa.gov/qryhtml/icao/). For the
3005             weather.com site this must be a valid location ID (see
3006             for instance
3007             http://aspnetresources.com/tools/locid.aspx).</p>
3008             <p>'data_type' must be one of the following:</p>
3009             <ul>
3010 <li>
3011                     <strong>last_update</strong> -
3012
3013                     <p>The date and time stamp of the data.
3014                     The result depends on the URI used. For the
3015                     NOAA site it is date (yyyy/mm/dd) and UTC time.
3016                     For the weather.com one it is date
3017                     ([m]m/[d]d/yy) and Local Time of the
3018                     station.</p>
3019                 </li>
3020 <li>
3021                     <strong>temperature</strong> -
3022
3023                                         <p>Air temperature (you can use the
3024                     'temperature_unit' config setting to change
3025                                         units)</p>
3026                 </li>
3027 <li>
3028                     <strong>cloud_cover</strong> -
3029
3030                     <p>The highest cloud cover status</p>
3031                 </li>
3032 <li>
3033                     <strong>pressure</strong> -
3034
3035                     <p>Air pressure in millibar</p>
3036                 </li>
3037 <li>
3038                     <strong>wind_speed</strong> -
3039
3040                     <p>Wind speed in km/h</p>
3041                 </li>
3042 <li>
3043                     <strong>wind_dir</strong> -
3044
3045                     <p>Wind direction</p>
3046                 </li>
3047 <li>
3048                     <strong>wind_dir_DEG</strong> -
3049
3050                     <p>Compass wind direction</p>
3051                 </li>
3052 <li>
3053                     <strong>humidity</strong> -
3054
3055                     <p>Relative humidity in %</p>
3056                 </li>
3057 <li>
3058                     <strong>weather</strong> -
3059
3060                     <p>Any relevant weather event (rain, snow,
3061                     etc.). This is not used if you are querying the
3062                     weather.com site since this data is aggregated
3063                     into the cloud_cover one</p>
3064                 </li>
3065 <li>
3066                     <strong>icon</strong> -
3067
3068                     <p>Weather icon (only for
3069                     www.weather.com). Can be used together with the
3070                     icon kit provided upon registering to their
3071                     service.</p>
3072                 </li>
3073 </ul>
3074             <p>'delay_in_minutes' (optional, default 30) cannot
3075             be less than 30 minutes.</p>
3076             <p>This object is threaded, and once a thread is
3077             created it can't be explicitly destroyed. One thread
3078             will run for each URI specified.</p>
3079             <p>Note that these variables are still EXPERIMENTAL
3080             and can be subject to many future changes.</p>
3081         </td>
3082 </tr>
3083 <tr bgcolor="#b4cdcd">
3084 <td align="center">weather_forecast</td>
3085 <td align="center">URI locID day data_type
3086             (interval_in_minutes)</td>
3087 <td>
3088             <p>Download, parse and display weather forecast data
3089             for a given day (daytime only).</p>
3090             <p>For the 'URI', for the time being only
3091             http://xoap.weather.com/weather/local/ is
3092             supported. See 'weather' above for details of usage</p>
3093             <p>'locID', see 'weather' above.</p>
3094             <p>'day' is a number from 0 (today) to 4 (3 days
3095             after tomorrow).</p>
3096             <p>'data_type' must be one of the following:</p>
3097             <ul>
3098 <li>
3099                     <strong>day</strong> -
3100
3101                                         Day of the week
3102                                 </li>
3103 <li>
3104                     <strong>date</strong> -
3105
3106                                         Date, in the form MMM DD (ie. Jul 14)
3107                                 </li>
3108 <li>
3109                     <strong>low</strong> -
3110
3111                                         Minimun temperature (you can use the
3112                     'temperature_unit' config setting to change
3113                     units)
3114                                 </li>
3115 <li>
3116                     <strong>hi</strong> -
3117
3118                                         Maximum temperature (you can use the
3119                     'temperature_unit' config setting to change
3120                     units)
3121                                 </li>
3122 <li>
3123                     <strong>icon</strong> -
3124
3125                     Weather icon. Can be used together with the
3126                     icon kit provided upon registering to the weather.com
3127                     service
3128                                 </li>
3129 <li>
3130                     <strong>forecast</strong> -
3131
3132                     Weather forecast (sunny, rainy, etc.)
3133                                 </li>
3134 <li>
3135                     <strong>wind_speed</strong> -
3136
3137                     Wind speed in km/h
3138                 </li>
3139 <li>
3140                     <strong>wind_dir</strong> -
3141
3142                     Wind direction
3143                 </li>
3144 <li>
3145                     <strong>wind_dir_DEG</strong> -
3146
3147                     Compass wind direction
3148                 </li>
3149 <li>
3150                     <strong>humidity</strong> -
3151
3152                     Relative humidity in %
3153                 </li>
3154 <li>
3155                     <strong>precipitation</strong> -
3156
3157                     Probability of having a
3158                                         precipitation (in %)
3159                 </li>
3160 </ul>
3161             <p>'delay_in_minutes' (optional, default 210) cannot
3162             be lower than 210 min.</p>
3163             <p>This object is threaded, and once a thread is
3164             created it can't be explicitly destroyed. One thread
3165             will run for each URI specified. You can use any
3166             protocol that Curl supports.</p>
3167             <p>Note that these variables are still EXPERIMENTAL
3168             and can be subject to many future changes.</p>
3169         </td>
3170 </tr>
3171 <tr bgcolor="#fffafa">
3172 <td align="center">wireless_ap</td>
3173 <td align="center">(net)</td>
3174 <td>Wireless access point MAC address (Linux only)
3175         <p></p>
3176 </td>
3177 </tr>
3178 <tr bgcolor="#b4cdcd">
3179 <td align="center">wireless_bitrate</td>
3180 <td align="center">(net)</td>
3181 <td>Wireless bitrate (ie 11 Mb/s) (Linux only)
3182         <p></p>
3183 </td>
3184 </tr>
3185 <tr bgcolor="#fffafa">
3186 <td align="center">wireless_essid</td>
3187 <td align="center">(net)</td>
3188 <td>Wireless access point ESSID (Linux only)
3189         <p></p>
3190 </td>
3191 </tr>
3192 <tr bgcolor="#b4cdcd">
3193 <td align="center">wireless_link_bar</td>
3194 <td align="center">(height),(width) (net)</td>
3195 <td>Wireless link quality bar (Linux only)
3196         <p></p>
3197 </td>
3198 </tr>
3199 <tr bgcolor="#fffafa">
3200 <td align="center">wireless_link_qual</td>
3201 <td align="center">(net)</td>
3202 <td>Wireless link quality (Linux only)
3203         <p></p>
3204 </td>
3205 </tr>
3206 <tr bgcolor="#b4cdcd">
3207 <td align="center">wireless_link_qual_max</td>
3208 <td align="center">(net)</td>
3209 <td>Wireless link quality maximum value (Linux only)
3210         <p></p>
3211 </td>
3212 </tr>
3213 <tr bgcolor="#fffafa">
3214 <td align="center">wireless_link_qual_perc</td>
3215 <td align="center">(net)</td>
3216 <td>Wireless link quality in percents (Linux only)
3217         <p></p>
3218 </td>
3219 </tr>
3220 <tr bgcolor="#b4cdcd">
3221 <td align="center">wireless_mode</td>
3222 <td align="center">(net)</td>
3223 <td>Wireless mode (Managed/Ad-Hoc/Master) (Linux
3224         only)
3225         <p></p>
3226 </td>
3227 </tr>
3228 <tr bgcolor="#fffafa">
3229 <td align="center">words</td>
3230 <td align="center">textfile</td>
3231 <td>Displays the number of words in the given file
3232         <p></p>
3233 </td>
3234 </tr>
3235 <tr bgcolor="#b4cdcd">
3236 <td align="center">xmms2_album</td>
3237 <td align="center"></td>
3238 <td>Album in current XMMS2 song
3239         <p></p>
3240 </td>
3241 </tr>
3242 <tr bgcolor="#fffafa">
3243 <td align="center">xmms2_artist</td>
3244 <td align="center"></td>
3245 <td>Artist in current XMMS2 song
3246         <p></p>
3247 </td>
3248 </tr>
3249 <tr bgcolor="#b4cdcd">
3250 <td align="center">xmms2_bar</td>
3251 <td align="center">(height),(width)</td>
3252 <td>Bar of XMMS2's progress
3253         <p></p>
3254 </td>
3255 </tr>
3256 <tr bgcolor="#fffafa">
3257 <td align="center">xmms2_bitrate</td>
3258 <td align="center"></td>
3259 <td>Bitrate of current song
3260         <p></p>
3261 </td>
3262 </tr>
3263 <tr bgcolor="#b4cdcd">
3264 <td align="center">xmms2_comment</td>
3265 <td align="center"></td>
3266 <td>Comment in current XMMS2 song
3267         <p></p>
3268 </td>
3269 </tr>
3270 <tr bgcolor="#fffafa">
3271 <td align="center">xmms2_date</td>
3272 <td align="center"></td>
3273 <td>Returns song's date.
3274         <p></p>
3275 </td>
3276 </tr>
3277 <tr bgcolor="#b4cdcd">
3278 <td align="center">xmms2_duration</td>
3279 <td align="center"></td>
3280 <td>Duration of current song
3281         <p></p>
3282 </td>
3283 </tr>
3284 <tr bgcolor="#fffafa">
3285 <td align="center">xmms2_elapsed</td>
3286 <td align="center"></td>
3287 <td>Song's elapsed time
3288         <p></p>
3289 </td>
3290 </tr>
3291 <tr bgcolor="#b4cdcd">
3292 <td align="center">xmms2_genre</td>
3293 <td align="center"></td>
3294 <td>Genre in current XMMS2 song
3295         <p></p>
3296 </td>
3297 </tr>
3298 <tr bgcolor="#fffafa">
3299 <td align="center">xmms2_id</td>
3300 <td align="center"></td>
3301 <td>XMMS2 id of current song
3302         <p></p>
3303 </td>
3304 </tr>
3305 <tr bgcolor="#b4cdcd">
3306 <td align="center">xmms2_percent</td>
3307 <td align="center"></td>
3308 <td>Percent of song's progress
3309         <p></p>
3310 </td>
3311 </tr>
3312 <tr bgcolor="#fffafa">
3313 <td align="center">xmms2_playlist</td>
3314 <td align="center"></td>
3315 <td>Returns the XMMS2 playlist.
3316         <p></p>
3317 </td>
3318 </tr>
3319 <tr bgcolor="#b4cdcd">
3320 <td align="center">xmms2_size</td>
3321 <td align="center"></td>
3322 <td>Size of current song
3323         <p></p>
3324 </td>
3325 </tr>
3326 <tr bgcolor="#fffafa">
3327 <td align="center">xmms2_smart</td>
3328 <td align="center"></td>
3329 <td>Prints the song name in either the form "artist -
3330         title" or file name, depending on whats available
3331         <p></p>
3332 </td>
3333 </tr>
3334 <tr bgcolor="#b4cdcd">
3335 <td align="center">xmms2_status</td>
3336 <td align="center"></td>
3337 <td>XMMS2 status (Playing, Paused, Stopped, or
3338         Disconnected)
3339         <p></p>
3340 </td>
3341 </tr>
3342 <tr bgcolor="#fffafa">
3343 <td align="center">xmms2_timesplayed</td>
3344 <td align="center"></td>
3345 <td>Number of times a song was played (presumably).
3346         <p></p>
3347 </td>
3348 </tr>
3349 <tr bgcolor="#b4cdcd">
3350 <td align="center">xmms2_title</td>
3351 <td align="center"></td>
3352 <td>Title in current XMMS2 song
3353         <p></p>
3354 </td>
3355 </tr>
3356 <tr bgcolor="#fffafa">
3357 <td align="center">xmms2_tracknr</td>
3358 <td align="center"></td>
3359 <td>Track number in current XMMS2 song
3360         <p></p>
3361 </td>
3362 </tr>
3363 <tr bgcolor="#b4cdcd">
3364 <td align="center">xmms2_url</td>
3365 <td align="center"></td>
3366 <td>Full path to current song
3367         <p></p>
3368 </td>
3369 </tr>
3370 </table></body>
3371 </html>