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