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