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

   1 <variablelist>
   2 <varlistentry>
   3         <term>
   4                 <command><option>addr</option></command>
   5         <option>interface</option>
   6         </term>
   7         <listitem>
   8                 IP address for an interface
   9         <para></para></listitem>
  10 </varlistentry>
  11
  12 <varlistentry>
  13         <term>
  14                 <command><option>acpiacadapter</option></command>
  15         </term>
  16         <listitem>
  17                 ACPI ac adapter state.
  18         <para></para></listitem>
  19 </varlistentry>
  20
  21 <varlistentry>
  22         <term>
  23                 <command><option>acpifan</option></command>
  24         </term>
  25         <listitem>
  26                 ACPI fan state
  27         <para></para></listitem>
  28 </varlistentry>
  29
  30 <varlistentry>
  31         <term>
  32                 <command><option>acpitemp</option></command>
  33         </term>
  34         <listitem>
  35                 ACPI temperature in C.
  36                 <para></para></listitem>
  37 </varlistentry>
  38
  39 <varlistentry>
  40         <term>
  41                 <command><option>acpitempf</option></command>
  42         </term>
  43         <listitem>
  44                 ACPI temperature in F.
  45                 <para></para></listitem>
  46 </varlistentry>
  47
  48 <varlistentry>
  49         <term>
  50                 <command><option>adt746xcpu</option></command>
  51         </term>
  52         <listitem>
  53                 CPU temperature from therm_adt746x
  54         <para></para></listitem>
  55 </varlistentry>
  56
  57 <varlistentry>
  58         <term>
  59                 <command><option>adt746xfan</option></command>
  60         </term>
  61         <listitem>
  62                 Fan speed from therm_adt746x
  63         <para></para></listitem>
  64 </varlistentry>
  65
  66 <varlistentry>
  67         <term>
  68                 <command><option>alignr</option></command>
  69         <option>(num)</option>
  70         </term>
  71         <listitem>
  72                 Right-justify text, with space of N
  73         <para></para></listitem>
  74 </varlistentry>
  75
  76 <varlistentry>
  77         <term>
  78                 <command><option>alignc</option></command>
  79         <option>(num)</option>
  80         </term>
  81         <listitem>
  82                 Align text to centre
  83         <para></para></listitem>
  84 </varlistentry>
  85
  86 <varlistentry>
  87         <term>
  88                 <command><option>apm_adapter</option></command>
  89         </term>
  90         <listitem>
  91                 Display APM AC adapter status (FreeBSD only)
  92         <para></para></listitem>
  93 </varlistentry>
  94
  95 <varlistentry>
  96         <term>
  97                 <command><option>apm_battery_life</option></command>
  98         </term>
  99         <listitem>
 100                 Display APM battery life in percent (FreeBSD only)
 101         <para></para></listitem>
 102 </varlistentry>
 103
 104 <varlistentry>
 105         <term>
 106                 <command><option>apm_battery_time</option></command>
 107         </term>
 108         <listitem>
 109                 Display remaining APM battery life in hh:mm:ss or "unknown" if
 110                 AC adapterstatus is on-line or charging (FreeBSD only)
 111         <para></para></listitem>
 112 </varlistentry>
 113
 114 <varlistentry>
 115         <term>
 116                 <command><option>battery</option></command>
 117         <option>(num)</option>
 118         </term>
 119         <listitem>
 120                 Remaining capacity in ACPI or APM battery. ACPI battery number can be given as argument (default is BAT0).
 121         <para></para></listitem>
 122 </varlistentry>
 123
 124 <varlistentry>
 125         <term>
 126                 <command><option>bmpx_artist</option></command>
 127         </term>
 128         <listitem>
 129                 Artist in current BMPx track
 130         <para></para></listitem>
 131 </varlistentry>
 132
 133 <varlistentry>
 134         <term>
 135                 <command><option>bmpx_album</option></command>
 136         </term>
 137         <listitem>
 138                 Album in current BMPx track
 139         <para></para></listitem>
 140 </varlistentry>
 141
 142 <varlistentry>
 143         <term>
 144                 <command><option>bmpx_title</option></command>
 145         </term>
 146         <listitem>
 147                 Title of the current BMPx track
 148         <para></para></listitem>
 149 </varlistentry>
 150
 151 <varlistentry>
 152         <term>
 153                 <command><option>bmpx_track</option></command>
 154         </term>
 155         <listitem>
 156                 Track number of the current BMPx track
 157         <para></para></listitem>
 158 </varlistentry>
 159
 160 <varlistentry>
 161         <term>
 162                 <command><option>bmpx_bitrate</option></command>
 163         </term>
 164         <listitem>
 165                 Bitrate of the current BMPx track
 166         <para></para></listitem>
 167 </varlistentry>
 168
 169 <varlistentry>
 170         <term>
 171                 <command><option>bmpx_uri</option></command>
 172         </term>
 173         <listitem>
 174                 URI of the current BMPx track
 175         <para></para></listitem>
 176 </varlistentry>
 177
 178 <varlistentry>
 179         <term>
 180                 <command><option>buffers</option></command>
 181         </term>
 182         <listitem>
 183                 Amount of memory buffered
 184         <para></para></listitem>
 185 </varlistentry>
 186
 187 <varlistentry>
 188         <term>
 189                 <command><option>cached</option></command>
 190         </term>
 191         <listitem>
 192                 Amount of memory cached
 193         <para></para></listitem>
 194 </varlistentry>
 195
 196 <varlistentry>
 197         <term>
 198                 <command><option>color</option></command>
 199         <option>(color)</option>
 200         </term>
 201         <listitem>
 202                 Change drawing color to color
 203         <para></para></listitem>
 204 </varlistentry>
 205
 206 <varlistentry>
 207         <term>
 208                 <command><option>cpu</option></command>
 209                 <option>(cpuN)</option>
 210         </term>
 211         <listitem>
 212                 CPU usage in percents.  For SMP machines, the CPU number can be provided as an argument.  cpu0 is the total usage, and >=cpu1 are individual CPUs.
 213         <para></para></listitem>
 214 </varlistentry>
 215
 216 <varlistentry>
 217         <term>
 218                 <command><option>cpubar</option></command>
 219                 <option>(cpu number) (height),(width)</option>
 220         </term>
 221         <listitem>
 222                 Bar that shows CPU usage, height is bar's height in pixels.  See $cpu for more info on SMP.
 223         <para></para></listitem>
 224 </varlistentry>
 225
 226 <varlistentry>
 227         <term>
 228                 <command><option>cpugraph</option></command>
 229         <option>(cpu number) (height),(width) (gradient colour 1) (gradient colour 2)</option>
 230         </term>
 231         <listitem>
 232                 CPU usage graph, with optional colours in hex, minus the #.  See $cpu for more info on SMP.
 233         <para></para></listitem>
 234 </varlistentry>
 235
 236 <varlistentry>
 237         <term>
 238                 <command><option>diskio</option></command>
 239         </term>
 240         <listitem>
 241                 Displays current disk IO.
 242                 <para></para></listitem>
 243 </varlistentry>
 244
 245 <varlistentry>
 246         <term>
 247                 <command><option>diskiograph</option></command>
 248                 <option>(height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
 249         </term>
 250         <listitem>
 251                 Disk IO graph, colours defined in hex, minus the #.  If scale is non-zero, it becomes the scale for the graph.
 252                 <para></para></listitem>
 253 </varlistentry>
 254
 255 <varlistentry>
 256         <term>
 257                 <command><option>downspeed</option></command>
 258         <option>net</option>
 259         </term>
 260         <listitem>
 261                 Download speed in kilobytes
 262         <para></para></listitem>
 263 </varlistentry>
 264
 265 <varlistentry>
 266         <term>
 267                 <command><option>downspeedf</option></command>
 268         <option>net</option>
 269         </term>
 270         <listitem>
 271                 Download speed in kilobytes with one decimal
 272         <para></para></listitem>
 273 </varlistentry>
 274
 275 <varlistentry>
 276         <term>
 277                 <command><option>downspeedgraph</option></command>
 278                 <option>net (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
 279         </term>
 280         <listitem>
 281                 Download speed graph, colours defined in hex, minus the #.  If scale is non-zero, it becomes the scale for the graph.
 282         <para></para></listitem>
 283 </varlistentry>
 284
 285 <varlistentry>
 286         <term>
 287                 <command><option>else</option></command>
 288         </term>
 289         <listitem>
 290                 Text to show if any of the above are not true
 291         <para></para></listitem>
 292 </varlistentry>
 293
 294 <varlistentry>
 295         <term>
 296                 <command><option>exec</option></command>
 297         <option>command</option>
 298         </term>
 299         <listitem>
 300                 Executes a shell command and displays the output in conky. warning: this takes a lot more resources than other variables. I'd recommend coding wanted behaviour in C and posting a patch.
 301         <para></para></listitem>
 302 </varlistentry>
 303
 304 <varlistentry>
 305         <term>
 306                 <command><option>execbar</option></command>
 307         <option>command</option>
 308         </term>
 309         <listitem>
 310                 Same as exec, except if the first value return is a value between 0-100, it will use that number for a bar. The size for the bar is currently fixed, but that may change in the future.
 311         <para></para></listitem>
 312 </varlistentry>
 313
 314 <varlistentry>
 315         <term>
 316                 <command><option>execgraph</option></command>
 317         <option>command</option>
 318         </term>
 319         <listitem>
 320                 Same as execbar, but graphs values.
 321         <para></para></listitem>
 322 </varlistentry>
 323
 324 <varlistentry>
 325         <term>
 326                 <command><option>execi</option></command>
 327                 <option>interval command</option>
 328         </term>
 329         <listitem>
 330                 Same as exec but with specific interval. Interval can't be less than update_interval in configuration. See also $texeci
 331                 <para></para></listitem>
 332 </varlistentry>
 333
 334 <varlistentry>
 335         <term>
 336                 <command><option>execibar</option></command>
 337                 <option>interval command</option>
 338         </term>
 339         <listitem>
 340                 Same as execbar, except with an interval
 341                 <para></para></listitem>
 342 </varlistentry>
 343
 344 <varlistentry>
 345         <term>
 346                 <command><option>execigraph</option></command>
 347                 <option>interval command</option>
 348         </term>
 349         <listitem>
 350                 Same as execigraph, but takes an interval arg graphs values
 351                 <para></para></listitem>
 352 </varlistentry>
 353
 354 <varlistentry>
 355         <term>
 356                 <command><option>font</option></command>
 357         <option>(font)</option>
 358         </term>
 359         <listitem>
 360                 Specify a different font. This new font will apply to the current line and everything following.  You can use a $font with no arguments to change back to the default font (much like with $color)
 361         <para></para></listitem>
 362 </varlistentry>
 363
 364
 365         <varlistentry>
 366                 <term>
 367                         <command><option>freq</option></command>
 368                 </term>
 369                 <listitem>
 370                         Returns CPU frequency in MHz
 371                         <para></para></listitem>
 372         </varlistentry>
 373         <varlistentry>
 374                 <term>
 375                         <command><option>freq_g</option></command>
 376                 </term>
 377                 <listitem>
 378                         Returns CPU frequency in GHz
 379                         <para></para></listitem>
 380         </varlistentry>
 381
 382         <varlistentry>
 383                 <term>
 384                         <command><option>freq_dyn</option></command>
 385                 </term>
 386                 <listitem>
 387                         Returns CPU frequency in MHz, but is calculated by counting to clock cycles to complete an instruction.  Only available for x86/amd64.
 388                         <para></para></listitem>
 389         </varlistentry>
 390         <varlistentry>
 391                 <term>
 392                         <command><option>freq_dyn_g</option></command>
 393                 </term>
 394                 <listitem>
 395                         Returns CPU frequency in GHz, but is calculated by counting to clock cycles to complete an instruction.  Only available for x86/amd64.
 396                         <para></para></listitem>
 397         </varlistentry>
 398
 399         <varlistentry>
 400         <term>
 401                 <command><option>fs_bar</option></command>
 402         <option>(height),(width) fs</option>
 403         </term>
 404         <listitem>
 405                 Bar that shows how much space is used on a file system. height is the height in pixels. fs is any file on that file system.
 406         <para></para></listitem>
 407 </varlistentry>
 408
 409 <varlistentry>
 410         <term>
 411                 <command><option>fs_free</option></command>
 412         <option>(fs)</option>
 413         </term>
 414         <listitem>
 415                 Free space on a file system available for users.
 416         <para></para></listitem>
 417 </varlistentry>
 418
 419 <varlistentry>
 420         <term>
 421                 <command><option>fs_free_perc</option></command>
 422         <option>(fs)</option>
 423         </term>
 424         <listitem>
 425                 Free percentage of space on a file system available for users.
 426         <para></para></listitem>
 427 </varlistentry>
 428
 429 <varlistentry>
 430         <term>
 431                 <command><option>fs_size</option></command>
 432         <option>(fs)</option>
 433         </term>
 434         <listitem>
 435                 File system size
 436         <para></para></listitem>
 437 </varlistentry>
 438
 439 <varlistentry>
 440         <term>
 441                 <command><option>fs_used</option></command>
 442         <option>(fs)</option>
 443         </term>
 444         <listitem>
 445                 File system used space
 446         <para></para></listitem>
 447 </varlistentry>
 448
 449 <varlistentry>
 450         <term>
 451                 <command><option>head</option></command>
 452                 <option>logfile lines (interval)</option>
 453         </term>
 454         <listitem>
 455                 Displays first N lines of supplied text text file. If interval is not supplied, Conky assumes 2x Conky's interval. Max of 30 lines can be displayed, or until the text buffer is filled.
 456                 <para></para></listitem>
 457 </varlistentry>
 458
 459 <varlistentry>
 460         <term>
 461                 <command><option>hr</option></command>
 462         <option>(height)</option>
 463         </term>
 464         <listitem>
 465                 Horizontal line, height is the height in pixels
 466         <para></para></listitem>
 467 </varlistentry>
 468
 469 <varlistentry>
 470         <term>
 471                 <command><option>iconv_start</option></command>
 472         <option>codeset_from codeset_to</option>
 473         </term>
 474         <listitem>
 475                 Convert text from one codeset to another using GNU iconv.  Needs to be stopped with iconv_stop.
 476         <para></para></listitem>
 477 </varlistentry>
 478
 479 <varlistentry>
 480         <term>
 481                 <command><option>iconv_stop</option></command>
 482         <option></option>
 483         </term>
 484         <listitem>
 485                 Stop iconv codeset conversion.
 486         <para></para></listitem>
 487 </varlistentry>
 488
 489 <varlistentry>
 490         <term>
 491                 <command><option>i2c</option></command>
 492         <option>(dev) type n</option>
 493         </term>
 494         <listitem>
 495                 I2C sensor from sysfs (Linux 2.6). dev may be omitted if you have only one I2C device. type is either in (or vol) meaning voltage, fan meaning fan or temp/tempf (first in C, second in F) meaning temperature. n is number of the sensor. See /sys/bus/i2c/devices/ on your local computer.
 496         <para></para></listitem>
 497 </varlistentry>
 498
 499 <varlistentry>
 500         <term>
 501                 <command><option>i8k_ac_status</option></command>
 502         <option></option>
 503         </term>
 504         <listitem>
 505                 If running the i8k kernel driver for Inspiron laptops, displays whether ac power is on, as listed in /proc/i8k (translated to human-readable). Beware that this is by default not enabled by i8k itself.
 506         <para></para></listitem>
 507 </varlistentry>
 508
 509 <varlistentry>
 510         <term>
 511                 <command><option>i8k_bios</option></command>
 512         <option></option>
 513         </term>
 514         <listitem>
 515                 If running the i8k kernel driver for Inspiron laptops, displays the bios version as listed in /proc/i8k.
 516         <para></para></listitem>
 517 </varlistentry>
 518
 519 <varlistentry>
 520         <term>
 521                 <command><option>i8k_buttons_status</option></command>
 522         <option></option>
 523         </term>
 524         <listitem>
 525                 If running the i8k kernel driver for Inspiron laptops, displays the volume buttons status as listed in /proc/i8k.
 526         <para></para></listitem>
 527 </varlistentry>
 528
 529 <varlistentry>
 530         <term>
 531                 <command><option>i8k_cpu_temp</option></command>
 532         <option></option>
 533         </term>
 534         <listitem>
 535                 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Celsius, as reported by /proc/i8k.
 536         <para></para></listitem>
 537 </varlistentry>
 538
 539 <varlistentry>
 540         <term>
 541                 <command><option>i8k_cpu_tempf</option></command>
 542         <option></option>
 543         </term>
 544         <listitem>
 545                 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Farenheit, as reported by /proc/i8k.
 546         <para></para></listitem>
 547 </varlistentry>
 548
 549 <varlistentry>
 550         <term>
 551                 <command><option>i8k_left_fan_rpm</option></command>
 552         <option></option>
 553         </term>
 554         <listitem>
 555                 If running the i8k kernel driver for Inspiron laptops, displays the left fan's rate of rotation, in revolutions per minute as listed in /proc/i8k. Beware, some laptops i8k reports these fans in reverse order.
 556         <para></para></listitem>
 557 </varlistentry>
 558
 559 <varlistentry>
 560         <term>
 561                 <command><option>i8k_left_fan_status</option></command>
 562         <option></option>
 563         </term>
 564         <listitem>
 565                 If running the i8k kernel driver for Inspiron laptops, displays the left fan status as listed in /proc/i8k (translated to human-readable). Beware, some laptops i8k reports these fans in reverse order.
 566         <para></para></listitem>
 567 </varlistentry>
 568
 569 <varlistentry>
 570         <term>
 571                 <command><option>i8k_right_fan_rpm</option></command>
 572         <option></option>
 573         </term>
 574         <listitem>
 575                 If running the i8k kernel driver for Inspiron laptops, displays the right fan's rate of rotation, in revolutions per minute as listed in /proc/i8k. Beware, some laptops i8k reports these fans in reverse order.
 576         <para></para></listitem>
 577 </varlistentry>
 578
 579 <varlistentry>
 580         <term>
 581                 <command><option>i8k_right_fan_status</option></command>
 582         <option></option>
 583         </term>
 584         <listitem>
 585                 If running the i8k kernel driver for Inspiron laptops, displays the right fan status as listed in /proc/i8k (translated to human-readable). Beware, some laptops i8k reports these fans in reverse order.
 586         <para></para></listitem>
 587 </varlistentry>
 588
 589 <varlistentry>
 590         <term>
 591                 <command><option>i8k_serial</option></command>
 592         <option></option>
 593         </term>
 594         <listitem>
 595                 If running the i8k kernel driver for Inspiron laptops, displays your laptop serial number as listed in /proc/i8k.
 596         <para></para></listitem>
 597 </varlistentry>
 598
 599 <varlistentry>
 600         <term>
 601                 <command><option>i8k_version</option></command>
 602         <option></option>
 603         </term>
 604         <listitem>
 605                 If running the i8k kernel driver for Inspiron laptops, displays the version formatting of /proc/i8k.
 606         <para></para></listitem>
 607 </varlistentry>
 608
 609
 610 <varlistentry>
 611         <term>
 612                 <command><option>if_running</option></command>
 613         <option>(process)</option>
 614         </term>
 615         <listitem>
 616                 if PROCESS is running, display everything if_running and the matching $endif
 617         <para></para></listitem>
 618 </varlistentry>
 619
 620 <varlistentry>
 621         <term>
 622                 <command><option>if_existing</option></command>
 623         <option>(file)</option>
 624         </term>
 625         <listitem>
 626                 if FILE exists, display everything between if_existing and the matching $endif
 627         <para></para></listitem>
 628 </varlistentry>
 629
 630 <varlistentry>
 631         <term>
 632                 <command><option>if_mounted</option></command>
 633         <option>(mountpoint)</option>
 634         </term>
 635         <listitem>
 636                 if MOUNTPOINT is mounted, display everything between if_mounted and the matching $endif
 637         <para></para></listitem>
 638 </varlistentry>
 639
 640 <varlistentry>
 641         <term>
 642                 <command><option>imap_messages</option></command>
 643         <option>(args)</option>
 644         </term>
 645         <listitem>
 646                 Displays the number of messages in your global IMAP inbox by default.  You can define individual IMAP inboxes seperately by passing arguments to this object.  Arguments are: "host user pass [-i interval] [-p port] [-e command]".  Default port is 110, default interval is 5 minutes.  If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
 647         <para></para></listitem>
 648 </varlistentry>
 649
 650 <varlistentry>
 651         <term>
 652                 <command><option>imap_unseen</option></command>
 653         <option>(args)</option>
 654         </term>
 655         <listitem>
 656                 Displays the number of unseen messages in your global IMAP inbox by default.  You can define individual IMAP inboxes seperately by passing arguments to this object.  Arguments are: "host user pass [-i interval] [-p port] [-e command]".  Default port is 110, default interval is 5 minutes.  If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
 657         <para></para></listitem>
 658 </varlistentry>
 659
 660 <varlistentry>
 661         <term>
 662                 <command><option>kernel</option></command>
 663         </term>
 664         <listitem>
 665                 Kernel version
 666         <para></para></listitem>
 667 </varlistentry>
 668
 669 <varlistentry>
 670         <term>
 671                 <command><option>linkstatus</option></command>
 672         <option>interface</option>
 673         </term>
 674         <listitem>
 675                 Get the link status for wireless connections
 676         <para></para></listitem>
 677 </varlistentry>
 678
 679 <varlistentry>
 680         <term>
 681                 <command><option>loadavg</option></command>
 682         </term>
 683         <listitem>
 684                 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past 5 minutes and 3 for past 15 minutes.
 685         <para></para></listitem>
 686 </varlistentry>
 687
 688 <varlistentry>
 689         <term>
 690                 <command><option>machine</option></command>
 691         </term>
 692         <listitem>
 693                 Machine, i686 for example
 694         <para></para></listitem>
 695 </varlistentry>
 696
 697 <varlistentry>
 698         <term>
 699                 <command><option>mails</option></command>
 700         </term>
 701         <listitem>
 702                 Mail count in mail spool. You can use program like fetchmail to get mails from some server using your favourite protocol. See also new_mails.
 703         <para></para></listitem>
 704 </varlistentry>
 705
 706 <varlistentry>
 707         <term>
 708                 <command><option>mem</option></command>
 709         </term>
 710         <listitem>
 711                 Amount of memory in use
 712         <para></para></listitem>
 713 </varlistentry>
 714
 715 <varlistentry>
 716         <term>
 717                 <command><option>membar</option></command>
 718         <option>(height),(width)</option>
 719         </term>
 720         <listitem>
 721                 Bar that shows amount of memory in use
 722         <para></para></listitem>
 723 </varlistentry>
 724
 725 <varlistentry>
 726         <term>
 727                 <command><option>memmax</option></command>
 728         </term>
 729         <listitem>
 730                 Total amount of memory
 731         <para></para></listitem>
 732 </varlistentry>
 733
 734 <varlistentry>
 735         <term>
 736                 <command><option>memperc</option></command>
 737         </term>
 738         <listitem>
 739                 Percentage of memory in use
 740         <para></para></listitem>
 741 </varlistentry>
 742
 743 <varlistentry>
 744         <term>
 745                 <command><option>mpd_artist</option></command>
 746         </term>
 747         <listitem>
 748                 Artist in current MPD song must be enabled at compile
 749         <para></para></listitem>
 750 </varlistentry>
 751
 752 <varlistentry>
 753         <term>
 754                 <command><option>mpd_album</option></command>
 755         </term>
 756         <listitem>
 757                 Album in current MPD song
 758         <para></para></listitem>
 759 </varlistentry>
 760
 761 <varlistentry>
 762         <term>
 763                 <command><option>mpd_bar</option></command>
 764         <option>(height),(width)</option>
 765         </term>
 766         <listitem>
 767                 Bar of mpd's progress
 768         <para></para></listitem>
 769 </varlistentry>
 770
 771 <varlistentry>
 772         <term>
 773                 <command><option>mpd_bitrate</option></command>
 774         </term>
 775         <listitem>
 776                 Bitrate of current song
 777         <para></para></listitem>
 778 </varlistentry>
 779
 780 <varlistentry>
 781         <term>
 782                 <command><option>mpd_status</option></command>
 783         </term>
 784         <listitem>
 785                 Playing, stopped, et cetera.
 786         <para></para></listitem>
 787 </varlistentry>
 788
 789 <varlistentry>
 790         <term>
 791                 <command><option>mpd_title</option></command>
 792         </term>
 793         <listitem>
 794                 Title of current MPD song
 795         <para></para></listitem>
 796 </varlistentry>
 797
 798 <varlistentry>
 799         <term>
 800                 <command><option>mpd_vol</option></command>
 801         </term>
 802         <listitem>
 803                 MPD's volume
 804         <para></para></listitem>
 805 </varlistentry>
 806
 807 <varlistentry>
 808         <term>
 809                 <command><option>mpd_elapsed</option></command>
 810         </term>
 811         <listitem>
 812                 Song's elapsed time
 813         <para></para></listitem>
 814 </varlistentry>
 815
 816 <varlistentry>
 817         <term>
 818                 <command><option>mpd_length</option></command>
 819         </term>
 820         <listitem>
 821                 Song's length
 822         <para></para></listitem>
 823 </varlistentry>
 824
 825 <varlistentry>
 826         <term>
 827                 <command><option>mpd_percent</option></command>
 828         </term>
 829         <listitem>
 830                 Percent of song's progress
 831         <para></para></listitem>
 832 </varlistentry>
 833
 834 <varlistentry>
 835         <term>
 836                 <command><option>mpd_random</option></command>
 837         </term>
 838         <listitem>
 839                 Random status (On/Off)
 840         <para></para></listitem>
 841 </varlistentry>
 842
 843 <varlistentry>
 844         <term>
 845                 <command><option>mpd_repeat</option></command>
 846         </term>
 847         <listitem>
 848                 Repeat status (On/Off)
 849         <para></para></listitem>
 850 </varlistentry>
 851
 852 <varlistentry>
 853         <term>
 854                 <command><option>mpd_track</option></command>
 855         </term>
 856         <listitem>
 857                 Prints the MPD track field
 858         <para></para></listitem>
 859 </varlistentry>
 860
 861 <varlistentry>
 862         <term>
 863                 <command><option>mpd_name</option></command>
 864         </term>
 865         <listitem>
 866                 Prints the MPD name field
 867         <para></para></listitem>
 868 </varlistentry>
 869
 870 <varlistentry>
 871         <term>
 872                 <command><option>mpd_file</option></command>
 873         </term>
 874         <listitem>
 875                 Prints the file name of the current MPD song
 876         <para></para></listitem>
 877 </varlistentry>
 878
 879 <varlistentry>
 880         <term>
 881                 <command><option>mpd_smart</option></command>
 882         </term>
 883         <listitem>
 884                 Prints the song name in either the form "artist - title" or file name, depending on whats available
 885         <para></para></listitem>
 886 </varlistentry>
 887
 888 <varlistentry>
 889         <term>
 890                 <command><option>new_mails</option></command>
 891         </term>
 892         <listitem>
 893                 Unread mail count in mail spool.
 894         <para></para></listitem>
 895 </varlistentry>
 896
 897 <varlistentry>
 898         <term>
 899                 <command><option>nodename</option></command>
 900         </term>
 901         <listitem>
 902                 Hostname
 903         <para></para></listitem>
 904 </varlistentry>
 905
 906 <varlistentry>
 907         <term>
 908                 <command><option>outlinecolor</option></command>
 909         <option>(color)</option>
 910         </term>
 911         <listitem>
 912                 Change outline color
 913         <para></para></listitem>
 914 </varlistentry>
 915
 916 <varlistentry>
 917         <term>
 918                 <command><option>pb_battery</option></command>
 919                 <option>item</option>
 920         </term>
 921         <listitem>
 922                 If running on Apple powerbook/ibook, display
 923                 information on battery status. The item parameter
 924                 specifies, what information to display. Exactly one item
 925                 must be specified. Valid items are:
 926                 <simplelist>
 927                         <member><command>status</command>:
 928                                 Display if battery is fully charged, charging,
 929                                 discharging or absent (running on AC)
 930                         </member>
 931                         <member><command>percent</command>:
 932                                 Display charge of battery in percent, if
 933                                 charging or discharging. Nothing will be
 934                                 displayed, if battery is fully charged
 935                                 or absent.
 936                         </member>
 937                         <member><command>time</command>:
 938                                 Display the time remaining until the battery
 939                                 will be fully charged or discharged at current
 940                                 rate.  Nothing is displayed, if battery is
 941                                 absent or if it's present but fully charged
 942                                 and not discharging.
 943                         </member>
 944                 </simplelist>
 945         <para></para></listitem>
 946 </varlistentry>
 947
 948 <varlistentry>
 949         <term>
 950                 <command><option>pop3_unseen</option></command>
 951         <option>(args)</option>
 952         </term>
 953         <listitem>
 954                 Displays the number of unseen messages in your global POP3 inbox by default.  You can define individual POP3 inboxes seperately by passing arguments to this object.  Arguments are: "host user pass [-i interval] [-p port] [-e command]".  Default port is 110, default interval is 5 minutes.  If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
 955
 956                 <para></para></listitem>
 957 </varlistentry>
 958
 959 <varlistentry>
 960         <term>
 961                 <command><option>pop3_used</option></command>
 962         <option>(args)</option>
 963         </term>
 964         <listitem>
 965                 Displays the amount of space (in MiB, 2^20) used in your global POP3 inbox by default.  You can define individual POP3 inboxes seperately by passing arguments to this object.  Arguments are: "host user pass [-i interval] [-p port] [-e command]".  Default port is 110, default interval is 5 minutes.  If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
 966
 967                 <para></para></listitem>
 968 </varlistentry>
 969
 970 <varlistentry>
 971         <term>
 972                 <command><option>pre_exec</option></command>
 973         <option>shell command</option>
 974         </term>
 975         <listitem>
 976                 Executes a shell command one time before conky displays anything and puts output as text.
 977         <para></para></listitem>
 978 </varlistentry>
 979
 980 <varlistentry>
 981         <term>
 982                 <command><option>processes</option></command>
 983         </term>
 984         <listitem>
 985                 Total processes (sleeping and running)
 986         <para></para></listitem>
 987 </varlistentry>
 988
 989 <varlistentry>
 990         <term>
 991                 <command><option>running_processes</option></command>
 992         </term>
 993         <listitem>
 994                 Running processes (not sleeping), requires Linux 2.6
 995         <para></para></listitem>
 996 </varlistentry>
 997
 998 <varlistentry>
 999         <term>
1000                 <command><option>shadecolor</option></command>
1001         <option>(color)</option>
1002         </term>
1003         <listitem>
1004                 Change shading color
1005         <para></para></listitem>
1006 </varlistentry>
1007
1008 <varlistentry>
1009         <term>
1010                 <command><option>stippled_hr</option></command>
1011         <option>(space)</option>
1012         </term>
1013         <listitem>
1014                 Stippled (dashed) horizontal line
1015         <para></para></listitem>
1016 </varlistentry>
1017
1018 <varlistentry>
1019         <term>
1020                 <command><option>swapbar</option></command>
1021         <option>(height),(width)</option>
1022         </term>
1023         <listitem>
1024                 Bar that shows amount of swap in use
1025         <para></para></listitem>
1026 </varlistentry>
1027
1028 <varlistentry>
1029         <term>
1030                 <command><option>swap</option></command>
1031         </term>
1032         <listitem>
1033                 Amount of swap in use
1034         <para></para></listitem>
1035 </varlistentry>
1036
1037 <varlistentry>
1038         <term>
1039                 <command><option>swapmax</option></command>
1040         </term>
1041         <listitem>
1042                 Total amount of swap
1043         <para></para></listitem>
1044 </varlistentry>
1045
1046 <varlistentry>
1047         <term>
1048                 <command><option>swapperc</option></command>
1049         </term>
1050         <listitem>
1051                 Percentage of swap in use
1052         <para></para></listitem>
1053 </varlistentry>
1054
1055 <varlistentry>
1056         <term>
1057                 <command><option>sysname</option></command>
1058         </term>
1059         <listitem>
1060                 System name, Linux for example
1061         <para></para></listitem>
1062 </varlistentry>
1063
1064 <varlistentry>
1065         <term>
1066                 <command><option>tcp_portmon</option></command>
1067                 <option>port_begin port_end item (index)</option>
1068                 <emphasis>(ip4 only at present)</emphasis>
1069         </term>
1070         <listitem>
1071                 TCP port monitor for specified local ports.  Port numbers must be in the range 1 to 65535. Valid items are:
1072                 <simplelist>
1073                         <member><command>count</command> - total number of connections in the range
1074                                 </member>
1075                         <member><command>rip</command> - remote ip address
1076                                 </member>
1077                         <member><command>rhost</command> - remote host name
1078                                 </member>
1079                         <member><command>rport</command> - remote port number
1080                                 </member>
1081                         <member><command>rservice</command> - remote service name from /etc/services
1082                                 </member>
1083                         <member><command>lip</command> - local ip address
1084                                 </member>
1085                         <member><command>lhost</command> - local host name
1086                                 </member>
1087                         <member><command>lport</command> - local port number
1088                                 </member>
1089                         <member><command>lservice</command> - local service name from /etc/services
1090                                 </member>
1091                 </simplelist>The connection index provides you with access to each connection in the port monitor.  The monitor will return information for index values from 0 to n-1 connections.  Values higher than n-1 are simply ignored.  For the "count" item, the connection index must be omitted.  It is required for all other items.
1092                 <simplelist>
1093                         <member>Examples:</member>
1094                         <member><command>${tcp_portmon 6881 6999 count}</command> -
1095                                 displays the number of connections in the bittorrent port range</member>
1096                         <member><command>${tcp_portmon 22 22 rip 0}</command> -
1097                                 displays the remote host ip of the first sshd connection</member>
1098                         <member><command>${tcp_portmon 22 22 rip 9}</command> -
1099                                 displays the remote host ip of the tenth sshd connection</member>
1100                         <member><command>${tcp_portmon 1 1024 rhost 0}</command> -
1101                                 displays the remote host name of the first connection on a privileged port</member>
1102                         <member><command>${tcp_portmon 1 1024 rport 4}</command> -
1103                                 displays the remote host port of the fifth connection on a privileged port</member>
1104                         <member><command>${tcp_portmon 1 65535 lservice 14}</command> -
1105                                 displays the local service name of the fifteenth connection in the range of all ports</member>
1106                 </simplelist>Note that port monitor variables which share the same port range actually refer to the same monitor, so many references to a single port range for different items and different indexes all use the same monitor internally.  In other words, the program avoids creating redundant monitors.
1107         </listitem>
1108 </varlistentry>
1109
1110 <varlistentry>
1111         <term>
1112                 <command><option>texeci</option></command>
1113                 <option>interval command</option>
1114         </term>
1115         <listitem>
1116                 Runs a command at an interval inside a thread and displays the output.  Same as $execi, except the command is run inside a thread.  Use this if you have a slow script to keep Conky updating.  You should make the interval slightly longer then the time it takes your script to execute.  For example, if you have a script that take 5 seconds to execute, you should make the interval at least 6 seconds. See also $execi.
1117                 <para></para></listitem>
1118 </varlistentry>
1119
1120 <varlistentry>
1121         <term>
1122                 <command><option>offset</option></command>
1123                 <option>(pixels)</option>
1124         </term>
1125         <listitem>
1126                 Move text over by N pixels.  See also $voffset.
1127                 <para></para></listitem>
1128 </varlistentry>
1129
1130 <varlistentry>
1131         <term>
1132                 <command><option>tail</option></command>
1133                 <option>logfile lines (interval)</option>
1134         </term>
1135         <listitem>
1136                 Displays last N lines of supplied text text file. If interval is not supplied, Conky assumes 2x Conky's interval. Max of 30 lines can be displayed, or until the text buffer is filled.
1137         <para></para></listitem>
1138 </varlistentry>
1139
1140 <varlistentry>
1141         <term>
1142                 <command><option>time</option></command>
1143         <option>(format)</option>
1144         </term>
1145         <listitem>
1146                 Local time, see man strftime to get more information about format
1147         <para></para></listitem>
1148 </varlistentry>
1149
1150 <varlistentry>
1151         <term>
1152                 <command><option>totaldown</option></command>
1153         <option>net</option>
1154         </term>
1155         <listitem>
1156                 Total download, overflows at 4 GB on Linux with 32-bit arch and there doesn't seem to be a way to know how many times it has already done that before conky has started.
1157         <para></para></listitem>
1158 </varlistentry>
1159
1160 <varlistentry>
1161         <term>
1162                 <command><option>top</option></command>
1163         <option>type, num</option>
1164         </term>
1165         <listitem>
1166                 This takes arguments in the form:top (name) (number) Basically, processes are ranked from highest to lowest in terms of cpu usage, which is what (num) represents. The types are: "name", "pid", "cpu", and mem". There can be a max of 10 processes listed.
1167         <para></para></listitem>
1168 </varlistentry>
1169
1170 <varlistentry>
1171         <term>
1172                 <command><option>top_mem</option></command>
1173         <option>type, num</option>
1174         </term>
1175         <listitem>
1176                 Same as top, except sorted by mem usage instead of cpu
1177         <para></para></listitem>
1178 </varlistentry>
1179
1180 <varlistentry>
1181         <term>
1182                 <command><option>totalup</option></command>
1183         <option>net</option>
1184         </term>
1185         <listitem>
1186                 Total upload, this one too, may overflow
1187         <para></para></listitem>
1188 </varlistentry>
1189
1190 <varlistentry>
1191         <term>
1192                 <command><option>updates</option></command>
1193         <option>Number of updates</option>
1194         </term>
1195         <listitem>
1196                 for debugging
1197         <para></para></listitem>
1198 </varlistentry>
1199
1200 <varlistentry>
1201         <term>
1202                 <command><option>upspeed</option></command>
1203         <option>net</option>
1204         </term>
1205         <listitem>
1206                 Upload speed in kilobytes
1207         <para></para></listitem>
1208 </varlistentry>
1209
1210 <varlistentry>
1211         <term>
1212                 <command><option>upspeedf</option></command>
1213         <option>net</option>
1214         </term>
1215         <listitem>
1216                 Upload speed in kilobytes with one decimal
1217         <para></para></listitem>
1218 </varlistentry>
1219
1220 <varlistentry>
1221         <term>
1222                 <command><option>upspeedgraph</option></command>
1223                 <option>net (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
1224         </term>
1225         <listitem>
1226                 Upload speed graph, colours defined in hex, minus the #.  If scale is non-zero, it becomes the scale for the graph.
1227         <para></para></listitem>
1228 </varlistentry>
1229
1230 <varlistentry>
1231         <term>
1232                 <command><option>uptime</option></command>
1233         </term>
1234         <listitem>
1235                 Uptime
1236         <para></para></listitem>
1237 </varlistentry>
1238
1239 <varlistentry>
1240         <term>
1241                 <command><option>uptime_short</option></command>
1242         </term>
1243         <listitem>
1244                 Uptime in a shorter format
1245         <para></para></listitem>
1246 </varlistentry>
1247
1248 <varlistentry>
1249         <term>
1250                 <command><option>seti_prog</option></command>
1251         </term>
1252         <listitem>
1253                 Seti@home current progress
1254         <para></para></listitem>
1255 </varlistentry>
1256
1257 <varlistentry>
1258         <term>
1259                 <command><option>seti_progbar</option></command>
1260         <option>(height),(width)</option>
1261         </term>
1262         <listitem>
1263                 Seti@home current progress bar
1264         <para></para></listitem>
1265 </varlistentry>
1266
1267 <varlistentry>
1268         <term>
1269                 <command><option>seti_credit</option></command>
1270         </term>
1271         <listitem>
1272                 Seti@home total user credit
1273         <para></para></listitem>
1274 </varlistentry>
1275 <varlistentry>
1276         <term>
1277                 <command><option>voffset</option></command>
1278                 <option>(pixels)</option>
1279         </term>
1280         <listitem>
1281                 Change vertical offset by N pixels.  Negative values will cause text to overlap.  See also $offset.
1282                 <para></para></listitem>
1283 </varlistentry>
1284
1285 <varlistentry>
1286         <term>
1287                 <command><option>xmms_bar</option></command>
1288                 <option>(height),(width)</option>
1289         </term>
1290         <listitem>
1291                 xmms / bmp / audacious / infopipe: progress bar
1292         <para></para></listitem>
1293 </varlistentry>
1294
1295 <varlistentry>
1296         <term>
1297                 <command><option>xmms_bitrate</option></command>
1298         </term>
1299         <listitem>
1300                 xmms / bmp / audacious / infopipe: bitrate of current tune
1301         <para></para></listitem>
1302 </varlistentry>
1303
1304 <varlistentry>
1305         <term>
1306                 <command><option>xmms_channels</option></command>
1307         </term>
1308         <listitem>
1309                 xmms / bmp / audacious / infopipe: number of audio channels of current tune
1310         <para></para></listitem>
1311 </varlistentry>
1312
1313 <varlistentry>
1314         <term>
1315                 <command><option>xmms_filename</option></command>
1316         </term>
1317         <listitem>
1318                 xmms / bmp / audacious / infopipe: full path and filename of current tune
1319         <para></para></listitem>
1320 </varlistentry>
1321
1322 <varlistentry>
1323         <term>
1324                 <command><option>xmms_frequency</option></command>
1325         </term>
1326         <listitem>
1327                 xmms / bmp / audacious / infopipe: sampling frequency of current tune
1328         <para></para></listitem>
1329 </varlistentry>
1330
1331 <varlistentry>
1332         <term>
1333                 <command><option>xmms_length</option></command>
1334         </term>
1335         <listitem>
1336                 xmms / bmp / audacious / infopipe: total length of current tune as MM:SS
1337         <para></para></listitem>
1338 </varlistentry>
1339
1340 <varlistentry>
1341         <term>
1342                 <command><option>xmms_length_seconds</option></command>
1343         </term>
1344         <listitem>
1345                 xmms / bmp / audacious / infopipe: total length of current tune in seconds
1346         <para></para></listitem>
1347 </varlistentry>
1348
1349 <varlistentry>
1350         <term>
1351                 <command><option>xmms_playlist_position</option></command>
1352         </term>
1353         <listitem>
1354                 xmms / bmp / audacious / infopipe: playlist position of current tune
1355         <para></para></listitem>
1356 </varlistentry>
1357
1358 <varlistentry>
1359         <term>
1360                 <command><option>xmms_playlist_length</option></command>
1361         </term>
1362         <listitem>
1363                 xmms / bmp / audacious / infopipe: number of tunes in playlist
1364         <para></para></listitem>
1365 </varlistentry>
1366
1367 <varlistentry>
1368         <term>
1369                 <command><option>xmms_position</option></command>
1370         </term>
1371         <listitem>
1372                 xmms / bmp / audacious / infopipe: MM:SS position of current tune
1373         <para></para></listitem>
1374 </varlistentry>
1375
1376 <varlistentry>
1377         <term>
1378                 <command><option>xmms_position_seconds</option></command>
1379         </term>
1380         <listitem>
1381                 xmms / bmp / audacious / infopipe: position of current tune in seconds
1382         <para></para></listitem>
1383 </varlistentry>
1384
1385 <varlistentry>
1386         <term>
1387                 <command><option>xmms_status</option></command>
1388         </term>
1389         <listitem>
1390                 xmms / bmp / audacious / infopipe: player status (Playing/Paused/Stopped/Not running)
1391         <para></para></listitem>
1392 </varlistentry>
1393
1394 <varlistentry>
1395         <term>
1396                 <command><option>xmms_title</option></command>
1397         </term>
1398         <listitem>
1399                 xmms / bmp / audacious / infopipe: title of current tune
1400         <para></para></listitem>
1401 </varlistentry>
1402
1403 <varlistentry>
1404         <term>
1405                 <command><option>ibm_fan</option></command>
1406         </term>
1407         <listitem>
1408                 If running the IBM ACPI, displays the fan speed.
1409         <para></para></listitem>
1410 </varlistentry>
1411
1412 <varlistentry>
1413         <term>
1414                 <command><option>ibm_temps</option></command>
1415                 <option>N</option>
1416         </term>
1417         <listitem>
1418                 If running the IBM ACPI, displays the temperatures
1419                 from the IBM temperature sensors (N=0..7) Sensor 0 is
1420                 on the CPU, 3 is on the GPU.
1421         <para></para></listitem>
1422 </varlistentry>
1423
1424 <varlistentry>
1425         <term>
1426                 <command><option>ibm_volume</option></command>
1427         </term>
1428         <listitem>
1429                 If running the IBM ACPI, displays the "master" volume,
1430         controlled by the volume keys (0-14).
1431         <para></para></listitem>
1432 </varlistentry>
1433
1434 <varlistentry>
1435         <term>
1436                 <command><option>ibm_brightness</option></command>
1437         </term>
1438         <listitem>
1439                 If running the IBM ACPI, displays the brigtness of the
1440         laptops's LCD (0-7).
1441         <para></para></listitem>
1442 </varlistentry>
1443
1444 </variablelist>