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                         <option>(n)</option>
 369                 </term>
 370                 <listitem>
 371                         Returns CPU #n's frequency in MHz. CPUs are
 372                         counted from 1. If omitted, the parameter
 373                         defaults to 1.
 374                         <para></para></listitem>
 375         </varlistentry>
 376         <varlistentry>
 377                 <term>
 378                         <command><option>freq_g</option></command>
 379                         <option>(n)</option>
 380                 </term>
 381                 <listitem>
 382                         Returns CPU #n's frequency in GHz. CPUs are
 383                         counted from 1. If omitted, the parameter
 384                         defaults to 1.
 385                         <para></para></listitem>
 386         </varlistentry>
 387
 388         <varlistentry>
 389                 <term>
 390                         <command><option>voltage_mv</option></command>
 391                         <option>(n)</option>
 392                 </term>
 393                 <listitem>
 394                         Returns CPU #n's voltage in mV. CPUs are
 395                         counted from 1. If omitted, the parameter
 396                         defaults to 1.
 397                         <para></para></listitem>
 398         </varlistentry>
 399         <varlistentry>
 400                 <term>
 401                         <command><option>voltage_v</option></command>
 402                         <option>(n)</option>
 403                 </term>
 404                 <listitem>
 405                         Returns CPU #n's voltage in V. CPUs are
 406                         counted from 1. If omitted, the parameter
 407                         defaults to 1.
 408                         <para></para></listitem>
 409         </varlistentry>
 410
 411         <varlistentry>
 412                 <term>
 413                         <command><option>freq_dyn</option></command>
 414                 </term>
 415                 <listitem>
 416                         Returns CPU frequency in MHz, but is calculated by counting to clock cycles to complete an instruction.  Only available for x86/amd64.
 417                         <para></para></listitem>
 418         </varlistentry>
 419         <varlistentry>
 420                 <term>
 421                         <command><option>freq_dyn_g</option></command>
 422                 </term>
 423                 <listitem>
 424                         Returns CPU frequency in GHz, but is calculated by counting to clock cycles to complete an instruction.  Only available for x86/amd64.
 425                         <para></para></listitem>
 426         </varlistentry>
 427
 428         <varlistentry>
 429         <term>
 430                 <command><option>fs_bar</option></command>
 431         <option>(height),(width) fs</option>
 432         </term>
 433         <listitem>
 434                 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.
 435         <para></para></listitem>
 436 </varlistentry>
 437
 438 <varlistentry>
 439         <term>
 440                 <command><option>fs_free</option></command>
 441         <option>(fs)</option>
 442         </term>
 443         <listitem>
 444                 Free space on a file system available for users.
 445         <para></para></listitem>
 446 </varlistentry>
 447
 448 <varlistentry>
 449         <term>
 450                 <command><option>fs_free_perc</option></command>
 451         <option>(fs)</option>
 452         </term>
 453         <listitem>
 454                 Free percentage of space on a file system available for users.
 455         <para></para></listitem>
 456 </varlistentry>
 457
 458 <varlistentry>
 459         <term>
 460                 <command><option>fs_size</option></command>
 461         <option>(fs)</option>
 462         </term>
 463         <listitem>
 464                 File system size
 465         <para></para></listitem>
 466 </varlistentry>
 467
 468 <varlistentry>
 469         <term>
 470                 <command><option>fs_used</option></command>
 471         <option>(fs)</option>
 472         </term>
 473         <listitem>
 474                 File system used space
 475         <para></para></listitem>
 476 </varlistentry>
 477
 478 <varlistentry>
 479         <term>
 480                 <command><option>head</option></command>
 481                 <option>logfile lines (interval)</option>
 482         </term>
 483         <listitem>
 484                 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.
 485                 <para></para></listitem>
 486 </varlistentry>
 487
 488 <varlistentry>
 489         <term>
 490                 <command><option>hr</option></command>
 491         <option>(height)</option>
 492         </term>
 493         <listitem>
 494                 Horizontal line, height is the height in pixels
 495         <para></para></listitem>
 496 </varlistentry>
 497
 498 <varlistentry>
 499         <term>
 500                 <command><option>iconv_start</option></command>
 501         <option>codeset_from codeset_to</option>
 502         </term>
 503         <listitem>
 504                 Convert text from one codeset to another using GNU iconv.  Needs to be stopped with iconv_stop.
 505         <para></para></listitem>
 506 </varlistentry>
 507
 508 <varlistentry>
 509         <term>
 510                 <command><option>iconv_stop</option></command>
 511         <option></option>
 512         </term>
 513         <listitem>
 514                 Stop iconv codeset conversion.
 515         <para></para></listitem>
 516 </varlistentry>
 517
 518 <varlistentry>
 519         <term>
 520                 <command><option>i2c</option></command>
 521         <option>(dev) type n</option>
 522         </term>
 523         <listitem>
 524                 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.
 525         <para></para></listitem>
 526 </varlistentry>
 527
 528 <varlistentry>
 529         <term>
 530                 <command><option>i8k_ac_status</option></command>
 531         <option></option>
 532         </term>
 533         <listitem>
 534                 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.
 535         <para></para></listitem>
 536 </varlistentry>
 537
 538 <varlistentry>
 539         <term>
 540                 <command><option>i8k_bios</option></command>
 541         <option></option>
 542         </term>
 543         <listitem>
 544                 If running the i8k kernel driver for Inspiron laptops, displays the bios version as listed in /proc/i8k.
 545         <para></para></listitem>
 546 </varlistentry>
 547
 548 <varlistentry>
 549         <term>
 550                 <command><option>i8k_buttons_status</option></command>
 551         <option></option>
 552         </term>
 553         <listitem>
 554                 If running the i8k kernel driver for Inspiron laptops, displays the volume buttons status as listed in /proc/i8k.
 555         <para></para></listitem>
 556 </varlistentry>
 557
 558 <varlistentry>
 559         <term>
 560                 <command><option>i8k_cpu_temp</option></command>
 561         <option></option>
 562         </term>
 563         <listitem>
 564                 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Celsius, as reported by /proc/i8k.
 565         <para></para></listitem>
 566 </varlistentry>
 567
 568 <varlistentry>
 569         <term>
 570                 <command><option>i8k_cpu_tempf</option></command>
 571         <option></option>
 572         </term>
 573         <listitem>
 574                 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Farenheit, as reported by /proc/i8k.
 575         <para></para></listitem>
 576 </varlistentry>
 577
 578 <varlistentry>
 579         <term>
 580                 <command><option>i8k_left_fan_rpm</option></command>
 581         <option></option>
 582         </term>
 583         <listitem>
 584                 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.
 585         <para></para></listitem>
 586 </varlistentry>
 587
 588 <varlistentry>
 589         <term>
 590                 <command><option>i8k_left_fan_status</option></command>
 591         <option></option>
 592         </term>
 593         <listitem>
 594                 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.
 595         <para></para></listitem>
 596 </varlistentry>
 597
 598 <varlistentry>
 599         <term>
 600                 <command><option>i8k_right_fan_rpm</option></command>
 601         <option></option>
 602         </term>
 603         <listitem>
 604                 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.
 605         <para></para></listitem>
 606 </varlistentry>
 607
 608 <varlistentry>
 609         <term>
 610                 <command><option>i8k_right_fan_status</option></command>
 611         <option></option>
 612         </term>
 613         <listitem>
 614                 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.
 615         <para></para></listitem>
 616 </varlistentry>
 617
 618 <varlistentry>
 619         <term>
 620                 <command><option>i8k_serial</option></command>
 621         <option></option>
 622         </term>
 623         <listitem>
 624                 If running the i8k kernel driver for Inspiron laptops, displays your laptop serial number as listed in /proc/i8k.
 625         <para></para></listitem>
 626 </varlistentry>
 627
 628 <varlistentry>
 629         <term>
 630                 <command><option>i8k_version</option></command>
 631         <option></option>
 632         </term>
 633         <listitem>
 634                 If running the i8k kernel driver for Inspiron laptops, displays the version formatting of /proc/i8k.
 635         <para></para></listitem>
 636 </varlistentry>
 637
 638
 639 <varlistentry>
 640         <term>
 641                 <command><option>if_running</option></command>
 642         <option>(process)</option>
 643         </term>
 644         <listitem>
 645                 if PROCESS is running, display everything if_running and the matching $endif
 646         <para></para></listitem>
 647 </varlistentry>
 648
 649 <varlistentry>
 650         <term>
 651                 <command><option>if_existing</option></command>
 652         <option>(file)</option>
 653         </term>
 654         <listitem>
 655                 if FILE exists, display everything between if_existing and the matching $endif
 656         <para></para></listitem>
 657 </varlistentry>
 658
 659 <varlistentry>
 660         <term>
 661                 <command><option>if_mounted</option></command>
 662         <option>(mountpoint)</option>
 663         </term>
 664         <listitem>
 665                 if MOUNTPOINT is mounted, display everything between if_mounted and the matching $endif
 666         <para></para></listitem>
 667 </varlistentry>
 668
 669 <varlistentry>
 670         <term>
 671                 <command><option>imap_messages</option></command>
 672         <option>(args)</option>
 673         </term>
 674         <listitem>
 675                 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.
 676         <para></para></listitem>
 677 </varlistentry>
 678
 679 <varlistentry>
 680         <term>
 681                 <command><option>imap_unseen</option></command>
 682         <option>(args)</option>
 683         </term>
 684         <listitem>
 685                 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.
 686         <para></para></listitem>
 687 </varlistentry>
 688
 689 <varlistentry>
 690         <term>
 691                 <command><option>kernel</option></command>
 692         </term>
 693         <listitem>
 694                 Kernel version
 695         <para></para></listitem>
 696 </varlistentry>
 697
 698 <varlistentry>
 699         <term>
 700                 <command><option>linkstatus</option></command>
 701         <option>interface</option>
 702         </term>
 703         <listitem>
 704                 Get the link status for wireless connections
 705         <para></para></listitem>
 706 </varlistentry>
 707
 708 <varlistentry>
 709         <term>
 710                 <command><option>loadavg</option></command>
 711         </term>
 712         <listitem>
 713                 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past 5 minutes and 3 for past 15 minutes.
 714         <para></para></listitem>
 715 </varlistentry>
 716
 717 <varlistentry>
 718         <term>
 719                 <command><option>machine</option></command>
 720         </term>
 721         <listitem>
 722                 Machine, i686 for example
 723         <para></para></listitem>
 724 </varlistentry>
 725
 726 <varlistentry>
 727         <term>
 728                 <command><option>mails</option></command>
 729         </term>
 730         <listitem>
 731                 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.
 732         <para></para></listitem>
 733 </varlistentry>
 734
 735 <varlistentry>
 736         <term>
 737                 <command><option>mem</option></command>
 738         </term>
 739         <listitem>
 740                 Amount of memory in use
 741         <para></para></listitem>
 742 </varlistentry>
 743
 744 <varlistentry>
 745         <term>
 746                 <command><option>membar</option></command>
 747         <option>(height),(width)</option>
 748         </term>
 749         <listitem>
 750                 Bar that shows amount of memory in use
 751         <para></para></listitem>
 752 </varlistentry>
 753
 754 <varlistentry>
 755         <term>
 756                 <command><option>memmax</option></command>
 757         </term>
 758         <listitem>
 759                 Total amount of memory
 760         <para></para></listitem>
 761 </varlistentry>
 762
 763 <varlistentry>
 764         <term>
 765                 <command><option>memperc</option></command>
 766         </term>
 767         <listitem>
 768                 Percentage of memory in use
 769         <para></para></listitem>
 770 </varlistentry>
 771
 772 <varlistentry>
 773         <term>
 774                 <command><option>mpd_artist</option></command>
 775         </term>
 776         <listitem>
 777                 Artist in current MPD song must be enabled at compile
 778         <para></para></listitem>
 779 </varlistentry>
 780
 781 <varlistentry>
 782         <term>
 783                 <command><option>mpd_album</option></command>
 784         </term>
 785         <listitem>
 786                 Album in current MPD song
 787         <para></para></listitem>
 788 </varlistentry>
 789
 790 <varlistentry>
 791         <term>
 792                 <command><option>mpd_bar</option></command>
 793         <option>(height),(width)</option>
 794         </term>
 795         <listitem>
 796                 Bar of mpd's progress
 797         <para></para></listitem>
 798 </varlistentry>
 799
 800 <varlistentry>
 801         <term>
 802                 <command><option>mpd_bitrate</option></command>
 803         </term>
 804         <listitem>
 805                 Bitrate of current song
 806         <para></para></listitem>
 807 </varlistentry>
 808
 809 <varlistentry>
 810         <term>
 811                 <command><option>mpd_status</option></command>
 812         </term>
 813         <listitem>
 814                 Playing, stopped, et cetera.
 815         <para></para></listitem>
 816 </varlistentry>
 817
 818 <varlistentry>
 819         <term>
 820                 <command><option>mpd_title</option></command>
 821         </term>
 822         <listitem>
 823                 Title of current MPD song
 824         <para></para></listitem>
 825 </varlistentry>
 826
 827 <varlistentry>
 828         <term>
 829                 <command><option>mpd_vol</option></command>
 830         </term>
 831         <listitem>
 832                 MPD's volume
 833         <para></para></listitem>
 834 </varlistentry>
 835
 836 <varlistentry>
 837         <term>
 838                 <command><option>mpd_elapsed</option></command>
 839         </term>
 840         <listitem>
 841                 Song's elapsed time
 842         <para></para></listitem>
 843 </varlistentry>
 844
 845 <varlistentry>
 846         <term>
 847                 <command><option>mpd_length</option></command>
 848         </term>
 849         <listitem>
 850                 Song's length
 851         <para></para></listitem>
 852 </varlistentry>
 853
 854 <varlistentry>
 855         <term>
 856                 <command><option>mpd_percent</option></command>
 857         </term>
 858         <listitem>
 859                 Percent of song's progress
 860         <para></para></listitem>
 861 </varlistentry>
 862
 863 <varlistentry>
 864         <term>
 865                 <command><option>mpd_random</option></command>
 866         </term>
 867         <listitem>
 868                 Random status (On/Off)
 869         <para></para></listitem>
 870 </varlistentry>
 871
 872 <varlistentry>
 873         <term>
 874                 <command><option>mpd_repeat</option></command>
 875         </term>
 876         <listitem>
 877                 Repeat status (On/Off)
 878         <para></para></listitem>
 879 </varlistentry>
 880
 881 <varlistentry>
 882         <term>
 883                 <command><option>mpd_track</option></command>
 884         </term>
 885         <listitem>
 886                 Prints the MPD track field
 887         <para></para></listitem>
 888 </varlistentry>
 889
 890 <varlistentry>
 891         <term>
 892                 <command><option>mpd_name</option></command>
 893         </term>
 894         <listitem>
 895                 Prints the MPD name field
 896         <para></para></listitem>
 897 </varlistentry>
 898
 899 <varlistentry>
 900         <term>
 901                 <command><option>mpd_file</option></command>
 902         </term>
 903         <listitem>
 904                 Prints the file name of the current MPD song
 905         <para></para></listitem>
 906 </varlistentry>
 907
 908 <varlistentry>
 909         <term>
 910                 <command><option>mpd_smart</option></command>
 911         </term>
 912         <listitem>
 913                 Prints the song name in either the form "artist - title" or file name, depending on whats available
 914         <para></para></listitem>
 915 </varlistentry>
 916
 917 <varlistentry>
 918         <term>
 919                 <command><option>new_mails</option></command>
 920         </term>
 921         <listitem>
 922                 Unread mail count in mail spool.
 923         <para></para></listitem>
 924 </varlistentry>
 925
 926 <varlistentry>
 927         <term>
 928                 <command><option>nodename</option></command>
 929         </term>
 930         <listitem>
 931                 Hostname
 932         <para></para></listitem>
 933 </varlistentry>
 934
 935 <varlistentry>
 936         <term>
 937                 <command><option>outlinecolor</option></command>
 938         <option>(color)</option>
 939         </term>
 940         <listitem>
 941                 Change outline color
 942         <para></para></listitem>
 943 </varlistentry>
 944
 945 <varlistentry>
 946         <term>
 947                 <command><option>pb_battery</option></command>
 948                 <option>item</option>
 949         </term>
 950         <listitem>
 951                 If running on Apple powerbook/ibook, display
 952                 information on battery status. The item parameter
 953                 specifies, what information to display. Exactly one item
 954                 must be specified. Valid items are:
 955                 <simplelist>
 956                         <member><command>status</command>:
 957                                 Display if battery is fully charged, charging,
 958                                 discharging or absent (running on AC)
 959                         </member>
 960                         <member><command>percent</command>:
 961                                 Display charge of battery in percent, if
 962                                 charging or discharging. Nothing will be
 963                                 displayed, if battery is fully charged
 964                                 or absent.
 965                         </member>
 966                         <member><command>time</command>:
 967                                 Display the time remaining until the battery
 968                                 will be fully charged or discharged at current
 969                                 rate.  Nothing is displayed, if battery is
 970                                 absent or if it's present but fully charged
 971                                 and not discharging.
 972                         </member>
 973                 </simplelist>
 974         <para></para></listitem>
 975 </varlistentry>
 976
 977 <varlistentry>
 978         <term>
 979                 <command><option>pop3_unseen</option></command>
 980         <option>(args)</option>
 981         </term>
 982         <listitem>
 983                 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.
 984
 985                 <para></para></listitem>
 986 </varlistentry>
 987
 988 <varlistentry>
 989         <term>
 990                 <command><option>pop3_used</option></command>
 991         <option>(args)</option>
 992         </term>
 993         <listitem>
 994                 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.
 995
 996                 <para></para></listitem>
 997 </varlistentry>
 998
 999 <varlistentry>
1000         <term>
1001                 <command><option>pre_exec</option></command>
1002         <option>shell command</option>
1003         </term>
1004         <listitem>
1005                 Executes a shell command one time before conky displays anything and puts output as text.
1006         <para></para></listitem>
1007 </varlistentry>
1008
1009 <varlistentry>
1010         <term>
1011                 <command><option>processes</option></command>
1012         </term>
1013         <listitem>
1014                 Total processes (sleeping and running)
1015         <para></para></listitem>
1016 </varlistentry>
1017
1018 <varlistentry>
1019         <term>
1020                 <command><option>running_processes</option></command>
1021         </term>
1022         <listitem>
1023                 Running processes (not sleeping), requires Linux 2.6
1024         <para></para></listitem>
1025 </varlistentry>
1026
1027 <varlistentry>
1028         <term>
1029                 <command><option>shadecolor</option></command>
1030         <option>(color)</option>
1031         </term>
1032         <listitem>
1033                 Change shading color
1034         <para></para></listitem>
1035 </varlistentry>
1036
1037 <varlistentry>
1038         <term>
1039                 <command><option>stippled_hr</option></command>
1040         <option>(space)</option>
1041         </term>
1042         <listitem>
1043                 Stippled (dashed) horizontal line
1044         <para></para></listitem>
1045 </varlistentry>
1046
1047 <varlistentry>
1048         <term>
1049                 <command><option>swapbar</option></command>
1050         <option>(height),(width)</option>
1051         </term>
1052         <listitem>
1053                 Bar that shows amount of swap in use
1054         <para></para></listitem>
1055 </varlistentry>
1056
1057 <varlistentry>
1058         <term>
1059                 <command><option>swap</option></command>
1060         </term>
1061         <listitem>
1062                 Amount of swap in use
1063         <para></para></listitem>
1064 </varlistentry>
1065
1066 <varlistentry>
1067         <term>
1068                 <command><option>swapmax</option></command>
1069         </term>
1070         <listitem>
1071                 Total amount of swap
1072         <para></para></listitem>
1073 </varlistentry>
1074
1075 <varlistentry>
1076         <term>
1077                 <command><option>swapperc</option></command>
1078         </term>
1079         <listitem>
1080                 Percentage of swap in use
1081         <para></para></listitem>
1082 </varlistentry>
1083
1084 <varlistentry>
1085         <term>
1086                 <command><option>sysname</option></command>
1087         </term>
1088         <listitem>
1089                 System name, Linux for example
1090         <para></para></listitem>
1091 </varlistentry>
1092
1093 <varlistentry>
1094         <term>
1095                 <command><option>tcp_portmon</option></command>
1096                 <option>port_begin port_end item (index)</option>
1097                 <emphasis>(ip4 only at present)</emphasis>
1098         </term>
1099         <listitem>
1100                 TCP port monitor for specified local ports.  Port numbers must be in the range 1 to 65535. Valid items are:
1101                 <simplelist>
1102                         <member><command>count</command> - total number of connections in the range
1103                                 </member>
1104                         <member><command>rip</command> - remote ip address
1105                                 </member>
1106                         <member><command>rhost</command> - remote host name
1107                                 </member>
1108                         <member><command>rport</command> - remote port number
1109                                 </member>
1110                         <member><command>rservice</command> - remote service name from /etc/services
1111                                 </member>
1112                         <member><command>lip</command> - local ip address
1113                                 </member>
1114                         <member><command>lhost</command> - local host name
1115                                 </member>
1116                         <member><command>lport</command> - local port number
1117                                 </member>
1118                         <member><command>lservice</command> - local service name from /etc/services
1119                                 </member>
1120                 </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.
1121                 <simplelist>
1122                         <member>Examples:</member>
1123                         <member><command>${tcp_portmon 6881 6999 count}</command> -
1124                                 displays the number of connections in the bittorrent port range</member>
1125                         <member><command>${tcp_portmon 22 22 rip 0}</command> -
1126                                 displays the remote host ip of the first sshd connection</member>
1127                         <member><command>${tcp_portmon 22 22 rip 9}</command> -
1128                                 displays the remote host ip of the tenth sshd connection</member>
1129                         <member><command>${tcp_portmon 1 1024 rhost 0}</command> -
1130                                 displays the remote host name of the first connection on a privileged port</member>
1131                         <member><command>${tcp_portmon 1 1024 rport 4}</command> -
1132                                 displays the remote host port of the fifth connection on a privileged port</member>
1133                         <member><command>${tcp_portmon 1 65535 lservice 14}</command> -
1134                                 displays the local service name of the fifteenth connection in the range of all ports</member>
1135                 </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.
1136         </listitem>
1137 </varlistentry>
1138
1139 <varlistentry>
1140         <term>
1141                 <command><option>texeci</option></command>
1142                 <option>interval command</option>
1143         </term>
1144         <listitem>
1145                 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.
1146                 <para></para></listitem>
1147 </varlistentry>
1148
1149 <varlistentry>
1150         <term>
1151                 <command><option>offset</option></command>
1152                 <option>(pixels)</option>
1153         </term>
1154         <listitem>
1155                 Move text over by N pixels.  See also $voffset.
1156                 <para></para></listitem>
1157 </varlistentry>
1158
1159 <varlistentry>
1160         <term>
1161                 <command><option>tail</option></command>
1162                 <option>logfile lines (interval)</option>
1163         </term>
1164         <listitem>
1165                 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.
1166         <para></para></listitem>
1167 </varlistentry>
1168
1169 <varlistentry>
1170         <term>
1171                 <command><option>time</option></command>
1172         <option>(format)</option>
1173         </term>
1174         <listitem>
1175                 Local time, see man strftime to get more information about format
1176         <para></para></listitem>
1177 </varlistentry>
1178
1179 <varlistentry>
1180         <term>
1181                 <command><option>totaldown</option></command>
1182         <option>net</option>
1183         </term>
1184         <listitem>
1185                 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.
1186         <para></para></listitem>
1187 </varlistentry>
1188
1189 <varlistentry>
1190         <term>
1191                 <command><option>top</option></command>
1192         <option>type, num</option>
1193         </term>
1194         <listitem>
1195                 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.
1196         <para></para></listitem>
1197 </varlistentry>
1198
1199 <varlistentry>
1200         <term>
1201                 <command><option>top_mem</option></command>
1202         <option>type, num</option>
1203         </term>
1204         <listitem>
1205                 Same as top, except sorted by mem usage instead of cpu
1206         <para></para></listitem>
1207 </varlistentry>
1208
1209 <varlistentry>
1210         <term>
1211                 <command><option>totalup</option></command>
1212         <option>net</option>
1213         </term>
1214         <listitem>
1215                 Total upload, this one too, may overflow
1216         <para></para></listitem>
1217 </varlistentry>
1218
1219 <varlistentry>
1220         <term>
1221                 <command><option>updates</option></command>
1222         <option>Number of updates</option>
1223         </term>
1224         <listitem>
1225                 for debugging
1226         <para></para></listitem>
1227 </varlistentry>
1228
1229 <varlistentry>
1230         <term>
1231                 <command><option>upspeed</option></command>
1232         <option>net</option>
1233         </term>
1234         <listitem>
1235                 Upload speed in kilobytes
1236         <para></para></listitem>
1237 </varlistentry>
1238
1239 <varlistentry>
1240         <term>
1241                 <command><option>upspeedf</option></command>
1242         <option>net</option>
1243         </term>
1244         <listitem>
1245                 Upload speed in kilobytes with one decimal
1246         <para></para></listitem>
1247 </varlistentry>
1248
1249 <varlistentry>
1250         <term>
1251                 <command><option>upspeedgraph</option></command>
1252                 <option>net (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
1253         </term>
1254         <listitem>
1255                 Upload speed graph, colours defined in hex, minus the #.  If scale is non-zero, it becomes the scale for the graph.
1256         <para></para></listitem>
1257 </varlistentry>
1258
1259 <varlistentry>
1260         <term>
1261                 <command><option>uptime</option></command>
1262         </term>
1263         <listitem>
1264                 Uptime
1265         <para></para></listitem>
1266 </varlistentry>
1267
1268 <varlistentry>
1269         <term>
1270                 <command><option>uptime_short</option></command>
1271         </term>
1272         <listitem>
1273                 Uptime in a shorter format
1274         <para></para></listitem>
1275 </varlistentry>
1276
1277 <varlistentry>
1278         <term>
1279                 <command><option>seti_prog</option></command>
1280         </term>
1281         <listitem>
1282                 Seti@home current progress
1283         <para></para></listitem>
1284 </varlistentry>
1285
1286 <varlistentry>
1287         <term>
1288                 <command><option>seti_progbar</option></command>
1289         <option>(height),(width)</option>
1290         </term>
1291         <listitem>
1292                 Seti@home current progress bar
1293         <para></para></listitem>
1294 </varlistentry>
1295
1296 <varlistentry>
1297         <term>
1298                 <command><option>seti_credit</option></command>
1299         </term>
1300         <listitem>
1301                 Seti@home total user credit
1302         <para></para></listitem>
1303 </varlistentry>
1304 <varlistentry>
1305         <term>
1306                 <command><option>voffset</option></command>
1307                 <option>(pixels)</option>
1308         </term>
1309         <listitem>
1310                 Change vertical offset by N pixels.  Negative values will cause text to overlap.  See also $offset.
1311                 <para></para></listitem>
1312 </varlistentry>
1313
1314 <varlistentry>
1315         <term>
1316                 <command><option>xmms_bar</option></command>
1317                 <option>(height),(width)</option>
1318         </term>
1319         <listitem>
1320                 xmms / bmp / audacious / infopipe: progress bar
1321         <para></para></listitem>
1322 </varlistentry>
1323
1324 <varlistentry>
1325         <term>
1326                 <command><option>xmms_bitrate</option></command>
1327         </term>
1328         <listitem>
1329                 xmms / bmp / audacious / infopipe: bitrate of current tune
1330         <para></para></listitem>
1331 </varlistentry>
1332
1333 <varlistentry>
1334         <term>
1335                 <command><option>xmms_channels</option></command>
1336         </term>
1337         <listitem>
1338                 xmms / bmp / audacious / infopipe: number of audio channels of current tune
1339         <para></para></listitem>
1340 </varlistentry>
1341
1342 <varlistentry>
1343         <term>
1344                 <command><option>xmms_filename</option></command>
1345         </term>
1346         <listitem>
1347                 xmms / bmp / audacious / infopipe: full path and filename of current tune
1348         <para></para></listitem>
1349 </varlistentry>
1350
1351 <varlistentry>
1352         <term>
1353                 <command><option>xmms_frequency</option></command>
1354         </term>
1355         <listitem>
1356                 xmms / bmp / audacious / infopipe: sampling frequency of current tune
1357         <para></para></listitem>
1358 </varlistentry>
1359
1360 <varlistentry>
1361         <term>
1362                 <command><option>xmms_length</option></command>
1363         </term>
1364         <listitem>
1365                 xmms / bmp / audacious / infopipe: total length of current tune as MM:SS
1366         <para></para></listitem>
1367 </varlistentry>
1368
1369 <varlistentry>
1370         <term>
1371                 <command><option>xmms_length_seconds</option></command>
1372         </term>
1373         <listitem>
1374                 xmms / bmp / audacious / infopipe: total length of current tune in seconds
1375         <para></para></listitem>
1376 </varlistentry>
1377
1378 <varlistentry>
1379         <term>
1380                 <command><option>xmms_playlist_position</option></command>
1381         </term>
1382         <listitem>
1383                 xmms / bmp / audacious / infopipe: playlist position of current tune
1384         <para></para></listitem>
1385 </varlistentry>
1386
1387 <varlistentry>
1388         <term>
1389                 <command><option>xmms_playlist_length</option></command>
1390         </term>
1391         <listitem>
1392                 xmms / bmp / audacious / infopipe: number of tunes in playlist
1393         <para></para></listitem>
1394 </varlistentry>
1395
1396 <varlistentry>
1397         <term>
1398                 <command><option>xmms_position</option></command>
1399         </term>
1400         <listitem>
1401                 xmms / bmp / audacious / infopipe: MM:SS position of current tune
1402         <para></para></listitem>
1403 </varlistentry>
1404
1405 <varlistentry>
1406         <term>
1407                 <command><option>xmms_position_seconds</option></command>
1408         </term>
1409         <listitem>
1410                 xmms / bmp / audacious / infopipe: position of current tune in seconds
1411         <para></para></listitem>
1412 </varlistentry>
1413
1414 <varlistentry>
1415         <term>
1416                 <command><option>xmms_status</option></command>
1417         </term>
1418         <listitem>
1419                 xmms / bmp / audacious / infopipe: player status (Playing/Paused/Stopped/Not running)
1420         <para></para></listitem>
1421 </varlistentry>
1422
1423 <varlistentry>
1424         <term>
1425                 <command><option>xmms_title</option></command>
1426         </term>
1427         <listitem>
1428                 xmms / bmp / audacious / infopipe: title of current tune
1429         <para></para></listitem>
1430 </varlistentry>
1431
1432 <varlistentry>
1433         <term>
1434                 <command><option>ibm_fan</option></command>
1435         </term>
1436         <listitem>
1437                 If running the IBM ACPI, displays the fan speed.
1438         <para></para></listitem>
1439 </varlistentry>
1440
1441 <varlistentry>
1442         <term>
1443                 <command><option>ibm_temps</option></command>
1444                 <option>N</option>
1445         </term>
1446         <listitem>
1447                 If running the IBM ACPI, displays the temperatures
1448                 from the IBM temperature sensors (N=0..7) Sensor 0 is
1449                 on the CPU, 3 is on the GPU.
1450         <para></para></listitem>
1451 </varlistentry>
1452
1453 <varlistentry>
1454         <term>
1455                 <command><option>ibm_volume</option></command>
1456         </term>
1457         <listitem>
1458                 If running the IBM ACPI, displays the "master" volume,
1459         controlled by the volume keys (0-14).
1460         <para></para></listitem>
1461 </varlistentry>
1462
1463 <varlistentry>
1464         <term>
1465                 <command><option>ibm_brightness</option></command>
1466         </term>
1467         <listitem>
1468                 If running the IBM ACPI, displays the brigtness of the
1469         laptops's LCD (0-7).
1470         <para></para></listitem>
1471 </varlistentry>
1472
1473 </variablelist>