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>audacious_bar</option></command>
 117                 <option>(height),(width)</option>
 118         </term>
 119         <listitem>
 120                 Progress bar
 121         <para></para></listitem>
 122 </varlistentry>
 123
 124 <varlistentry>
 125         <term>
 126                 <command><option>audacious_bitrate</option></command>
 127         </term>
 128         <listitem>
 129                 Bitrate of current tune
 130         <para></para></listitem>
 131 </varlistentry>
 132
 133 <varlistentry>
 134         <term>
 135                 <command><option>audacious_channels</option></command>
 136         </term>
 137         <listitem>
 138                 Number of audio channels of current tune
 139         <para></para></listitem>
 140 </varlistentry>
 141
 142 <varlistentry>
 143         <term>
 144                 <command><option>audacious_filename</option></command>
 145         </term>
 146         <listitem>
 147                 Full path and filename of current tune
 148         <para></para></listitem>
 149 </varlistentry>
 150
 151 <varlistentry>
 152         <term>
 153                 <command><option>audacious_frequency</option></command>
 154         </term>
 155         <listitem>
 156                 Sampling frequency of current tune
 157         <para></para></listitem>
 158 </varlistentry>
 159
 160 <varlistentry>
 161         <term>
 162                 <command><option>audacious_length</option></command>
 163         </term>
 164         <listitem>
 165                 Total length of current tune as MM:SS
 166         <para></para></listitem>
 167 </varlistentry>
 168
 169 <varlistentry>
 170         <term>
 171                 <command><option>audacious_length_seconds</option></command>
 172         </term>
 173         <listitem>
 174                 Total length of current tune in seconds
 175         <para></para></listitem>
 176 </varlistentry>
 177
 178 <varlistentry>
 179         <term>
 180                 <command><option>audacious_playlist_position</option></command>
 181         </term>
 182         <listitem>
 183                 Playlist position of current tune
 184         <para></para></listitem>
 185 </varlistentry>
 186
 187 <varlistentry>
 188         <term>
 189                 <command><option>audacious_playlist_length</option></command>
 190         </term>
 191         <listitem>
 192                 Number of tunes in playlist
 193         <para></para></listitem>
 194 </varlistentry>
 195
 196 <varlistentry>
 197         <term>
 198                 <command><option>audacious_position</option></command>
 199         </term>
 200         <listitem>
 201                 Position of current tune (MM:SS)
 202         <para></para></listitem>
 203 </varlistentry>
 204
 205 <varlistentry>
 206         <term>
 207                 <command><option>audacious_position_seconds</option></command>
 208         </term>
 209         <listitem>
 210                 Position of current tune in seconds
 211         <para></para></listitem>
 212 </varlistentry>
 213
 214 <varlistentry>
 215         <term>
 216                 <command><option>audacious_status</option></command>
 217         </term>
 218         <listitem>
 219                 Player status (Playing/Paused/Stopped/Not running)
 220         <para></para></listitem>
 221 </varlistentry>
 222
 223 <varlistentry>
 224         <term>
 225                 <command><option>audacious_title</option></command>
 226         </term>
 227         <listitem>
 228                 Title of current tune
 229         <para></para></listitem>
 230 </varlistentry>
 231
 232 <varlistentry>
 233         <term>
 234                 <command><option>battery</option></command>
 235         <option>(num)</option>
 236         </term>
 237         <listitem>
 238                 Remaining capacity in ACPI or APM battery. ACPI battery number can be given as argument (default is BAT0).
 239         <para></para></listitem>
 240 </varlistentry>
 241
 242 <varlistentry>
 243         <term>
 244                 <command><option>bmpx_artist</option></command>
 245         </term>
 246         <listitem>
 247                 Artist in current BMPx track
 248         <para></para></listitem>
 249 </varlistentry>
 250
 251 <varlistentry>
 252         <term>
 253                 <command><option>bmpx_album</option></command>
 254         </term>
 255         <listitem>
 256                 Album in current BMPx track
 257         <para></para></listitem>
 258 </varlistentry>
 259
 260 <varlistentry>
 261         <term>
 262                 <command><option>bmpx_title</option></command>
 263         </term>
 264         <listitem>
 265                 Title of the current BMPx track
 266         <para></para></listitem>
 267 </varlistentry>
 268
 269 <varlistentry>
 270         <term>
 271                 <command><option>bmpx_track</option></command>
 272         </term>
 273         <listitem>
 274                 Track number of the current BMPx track
 275         <para></para></listitem>
 276 </varlistentry>
 277
 278 <varlistentry>
 279         <term>
 280                 <command><option>bmpx_bitrate</option></command>
 281         </term>
 282         <listitem>
 283                 Bitrate of the current BMPx track
 284         <para></para></listitem>
 285 </varlistentry>
 286
 287 <varlistentry>
 288         <term>
 289                 <command><option>bmpx_uri</option></command>
 290         </term>
 291         <listitem>
 292                 URI of the current BMPx track
 293         <para></para></listitem>
 294 </varlistentry>
 295
 296 <varlistentry>
 297         <term>
 298                 <command><option>buffers</option></command>
 299         </term>
 300         <listitem>
 301                 Amount of memory buffered
 302         <para></para></listitem>
 303 </varlistentry>
 304
 305 <varlistentry>
 306         <term>
 307                 <command><option>cached</option></command>
 308         </term>
 309         <listitem>
 310                 Amount of memory cached
 311         <para></para></listitem>
 312 </varlistentry>
 313
 314 <varlistentry>
 315         <term>
 316                 <command><option>color</option></command>
 317         <option>(color)</option>
 318         </term>
 319         <listitem>
 320                 Change drawing color to color
 321         <para></para></listitem>
 322 </varlistentry>
 323
 324 <varlistentry>
 325         <term>
 326                 <command><option>cpu</option></command>
 327                 <option>(cpuN)</option>
 328         </term>
 329         <listitem>
 330                 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.
 331         <para></para></listitem>
 332 </varlistentry>
 333
 334 <varlistentry>
 335         <term>
 336                 <command><option>cpubar</option></command>
 337                 <option>(cpu number) (height),(width)</option>
 338         </term>
 339         <listitem>
 340                 Bar that shows CPU usage, height is bar's height in pixels.  See $cpu for more info on SMP.
 341         <para></para></listitem>
 342 </varlistentry>
 343
 344 <varlistentry>
 345         <term>
 346                 <command><option>cpugraph</option></command>
 347         <option>(cpu number) (height),(width) (gradient colour 1) (gradient colour 2)</option>
 348         </term>
 349         <listitem>
 350                 CPU usage graph, with optional colours in hex, minus the #.  See $cpu for more info on SMP.
 351         <para></para></listitem>
 352 </varlistentry>
 353
 354 <varlistentry>
 355         <term>
 356                 <command><option>diskio</option></command>
 357         </term>
 358         <listitem>
 359                 Displays current disk IO.
 360                 <para></para></listitem>
 361 </varlistentry>
 362
 363 <varlistentry>
 364         <term>
 365                 <command><option>diskiograph</option></command>
 366                 <option>(height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
 367         </term>
 368         <listitem>
 369                 Disk IO graph, colours defined in hex, minus the #.  If scale is non-zero, it becomes the scale for the graph.
 370                 <para></para></listitem>
 371 </varlistentry>
 372
 373 <varlistentry>
 374         <term>
 375                 <command><option>downspeed</option></command>
 376         <option>net</option>
 377         </term>
 378         <listitem>
 379                 Download speed in kilobytes
 380         <para></para></listitem>
 381 </varlistentry>
 382
 383 <varlistentry>
 384         <term>
 385                 <command><option>downspeedf</option></command>
 386         <option>net</option>
 387         </term>
 388         <listitem>
 389                 Download speed in kilobytes with one decimal
 390         <para></para></listitem>
 391 </varlistentry>
 392
 393 <varlistentry>
 394         <term>
 395                 <command><option>downspeedgraph</option></command>
 396                 <option>net (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
 397         </term>
 398         <listitem>
 399                 Download speed graph, colours defined in hex, minus the #.  If scale is non-zero, it becomes the scale for the graph.
 400         <para></para></listitem>
 401 </varlistentry>
 402
 403 <varlistentry>
 404         <term>
 405                 <command><option>else</option></command>
 406         </term>
 407         <listitem>
 408                 Text to show if any of the above are not true
 409         <para></para></listitem>
 410 </varlistentry>
 411
 412 <varlistentry>
 413         <term>
 414                 <command><option>entropy_avail</option></command>
 415         </term>
 416         <listitem>
 417                 Current entropy available for crypto freaks
 418         <para></para></listitem>
 419 </varlistentry>
 420
 421 <varlistentry>
 422         <term>
 423                 <command><option>entropy_bar</option></command>
 424                 <option>(height),(width)</option>
 425         </term>
 426         <listitem>
 427                 Normalized bar of available entropy for crypto freaks
 428         <para></para></listitem>
 429 </varlistentry>
 430
 431 <varlistentry>
 432         <term>
 433                 <command><option>entropy_poolsize</option></command>
 434         </term>
 435         <listitem>
 436                 Total size of system entropy pool for crypto freaks
 437         <para></para></listitem>
 438 </varlistentry>
 439
 440
 441 <varlistentry>
 442         <term>
 443                 <command><option>exec</option></command>
 444         <option>command</option>
 445         </term>
 446         <listitem>
 447                 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.
 448         <para></para></listitem>
 449 </varlistentry>
 450
 451 <varlistentry>
 452         <term>
 453                 <command><option>execbar</option></command>
 454         <option>command</option>
 455         </term>
 456         <listitem>
 457                 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.
 458         <para></para></listitem>
 459 </varlistentry>
 460
 461 <varlistentry>
 462         <term>
 463                 <command><option>execgraph</option></command>
 464         <option>command</option>
 465         </term>
 466         <listitem>
 467                 Same as execbar, but graphs values.
 468         <para></para></listitem>
 469 </varlistentry>
 470
 471 <varlistentry>
 472         <term>
 473                 <command><option>execi</option></command>
 474                 <option>interval command</option>
 475         </term>
 476         <listitem>
 477                 Same as exec but with specific interval. Interval can't be less than update_interval in configuration. See also $texeci
 478                 <para></para></listitem>
 479 </varlistentry>
 480
 481 <varlistentry>
 482         <term>
 483                 <command><option>execibar</option></command>
 484                 <option>interval command</option>
 485         </term>
 486         <listitem>
 487                 Same as execbar, except with an interval
 488                 <para></para></listitem>
 489 </varlistentry>
 490
 491 <varlistentry>
 492         <term>
 493                 <command><option>execigraph</option></command>
 494                 <option>interval command</option>
 495         </term>
 496         <listitem>
 497                 Same as execigraph, but takes an interval arg graphs values
 498                 <para></para></listitem>
 499 </varlistentry>
 500
 501 <varlistentry>
 502         <term>
 503                 <command><option>font</option></command>
 504         <option>(font)</option>
 505         </term>
 506         <listitem>
 507                 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)
 508         <para></para></listitem>
 509 </varlistentry>
 510
 511 <varlistentry>
 512         <term>
 513                 <command><option>freq</option></command>
 514                 <option>(n)</option>
 515         </term>
 516         <listitem>
 517                 Returns CPU #n's frequency in MHz. CPUs are
 518                 counted from 1. If omitted, the parameter
 519                 defaults to 1.
 520                 <para></para></listitem>
 521 </varlistentry>
 522 <varlistentry>
 523         <term>
 524                 <command><option>freq_g</option></command>
 525                 <option>(n)</option>
 526         </term>
 527         <listitem>
 528                 Returns CPU #n's frequency in GHz. CPUs are
 529                 counted from 1. If omitted, the parameter
 530                 defaults to 1.
 531                 <para></para></listitem>
 532 </varlistentry>
 533
 534 <varlistentry>
 535         <term>
 536                 <command><option>freq_dyn</option></command>
 537         </term>
 538         <listitem>
 539                         Returns CPU frequency in MHz, but is calculated by counting to clock cycles to complete an instruction.  Only available for x86/amd64.
 540                         <para></para></listitem>
 541 </varlistentry>
 542
 543 <varlistentry>
 544         <term>
 545                 <command><option>freq_dyn_g</option></command>
 546         </term>
 547         <listitem>
 548                 Returns CPU frequency in GHz, but is calculated by counting to clock cycles to complete an instruction.  Only available for x86/amd64.
 549         <para></para></listitem>
 550 </varlistentry>
 551
 552 <varlistentry>
 553         <term>
 554                 <command><option>fs_bar</option></command>
 555         <option>(height),(width) fs</option>
 556         </term>
 557         <listitem>
 558                 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.
 559         <para></para></listitem>
 560 </varlistentry>
 561
 562 <varlistentry>
 563         <term>
 564                 <command><option>fs_free</option></command>
 565         <option>(fs)</option>
 566         </term>
 567         <listitem>
 568                 Free space on a file system available for users.
 569         <para></para></listitem>
 570 </varlistentry>
 571
 572 <varlistentry>
 573         <term>
 574                 <command><option>fs_free_perc</option></command>
 575         <option>(fs)</option>
 576         </term>
 577         <listitem>
 578                 Free percentage of space on a file system available for users.
 579         <para></para></listitem>
 580 </varlistentry>
 581
 582 <varlistentry>
 583         <term>
 584                 <command><option>fs_size</option></command>
 585         <option>(fs)</option>
 586         </term>
 587         <listitem>
 588                 File system size
 589         <para></para></listitem>
 590 </varlistentry>
 591
 592 <varlistentry>
 593         <term>
 594                 <command><option>fs_used</option></command>
 595         <option>(fs)</option>
 596         </term>
 597         <listitem>
 598                 File system used space
 599         <para></para></listitem>
 600 </varlistentry>
 601
 602 <varlistentry>
 603         <term>
 604                 <command><option>goto</option></command>
 605                 <option>x</option>
 606         </term>
 607         <listitem>
 608         The next element will be printed at position 'x'.
 609                 <para></para></listitem>
 610 </varlistentry>
 611
 612 <varlistentry>
 613         <term>
 614                 <command><option>hddtemp</option></command>
 615                 <option>dev, (host,(port))</option>
 616         </term>
 617         <listitem>
 618                 Displays temperature of a selected hard disk drive as reported by the hddtemp daemon running on host:port.
 619                 Default host is 127.0.0.1, default port is 7634.
 620                 <para></para></listitem>
 621 </varlistentry>
 622
 623 <varlistentry>
 624         <term>
 625                 <command><option>head</option></command>
 626                 <option>logfile lines (interval)</option>
 627         </term>
 628         <listitem>
 629                 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.
 630                 <para></para></listitem>
 631 </varlistentry>
 632
 633 <varlistentry>
 634         <term>
 635                 <command><option>hr</option></command>
 636         <option>(height)</option>
 637         </term>
 638         <listitem>
 639                 Horizontal line, height is the height in pixels
 640         <para></para></listitem>
 641 </varlistentry>
 642
 643 <varlistentry>
 644         <term>
 645                 <command><option>iconv_start</option></command>
 646         <option>codeset_from codeset_to</option>
 647         </term>
 648         <listitem>
 649                 Convert text from one codeset to another using GNU iconv.  Needs to be stopped with iconv_stop.
 650         <para></para></listitem>
 651 </varlistentry>
 652
 653 <varlistentry>
 654         <term>
 655                 <command><option>iconv_stop</option></command>
 656         <option></option>
 657         </term>
 658         <listitem>
 659                 Stop iconv codeset conversion.
 660         <para></para></listitem>
 661 </varlistentry>
 662
 663 <varlistentry>
 664         <term>
 665                 <command><option>i2c</option></command>
 666         <option>(dev) type n</option>
 667         </term>
 668         <listitem>
 669                 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.
 670         <para></para></listitem>
 671 </varlistentry>
 672
 673 <varlistentry>
 674         <term>
 675                 <command><option>i8k_ac_status</option></command>
 676         <option></option>
 677         </term>
 678         <listitem>
 679                 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.
 680         <para></para></listitem>
 681 </varlistentry>
 682
 683 <varlistentry>
 684         <term>
 685                 <command><option>i8k_bios</option></command>
 686         <option></option>
 687         </term>
 688         <listitem>
 689                 If running the i8k kernel driver for Inspiron laptops, displays the bios version as listed in /proc/i8k.
 690         <para></para></listitem>
 691 </varlistentry>
 692
 693 <varlistentry>
 694         <term>
 695                 <command><option>i8k_buttons_status</option></command>
 696         <option></option>
 697         </term>
 698         <listitem>
 699                 If running the i8k kernel driver for Inspiron laptops, displays the volume buttons status as listed in /proc/i8k.
 700         <para></para></listitem>
 701 </varlistentry>
 702
 703 <varlistentry>
 704         <term>
 705                 <command><option>i8k_cpu_temp</option></command>
 706         <option></option>
 707         </term>
 708         <listitem>
 709                 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Celsius, as reported by /proc/i8k.
 710         <para></para></listitem>
 711 </varlistentry>
 712
 713 <varlistentry>
 714         <term>
 715                 <command><option>i8k_cpu_tempf</option></command>
 716         <option></option>
 717         </term>
 718         <listitem>
 719                 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Fahrenheit, as reported by /proc/i8k.
 720         <para></para></listitem>
 721 </varlistentry>
 722
 723 <varlistentry>
 724         <term>
 725                 <command><option>i8k_left_fan_rpm</option></command>
 726         <option></option>
 727         </term>
 728         <listitem>
 729                 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.
 730         <para></para></listitem>
 731 </varlistentry>
 732
 733 <varlistentry>
 734         <term>
 735                 <command><option>i8k_left_fan_status</option></command>
 736         <option></option>
 737         </term>
 738         <listitem>
 739                 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.
 740         <para></para></listitem>
 741 </varlistentry>
 742
 743 <varlistentry>
 744         <term>
 745                 <command><option>i8k_right_fan_rpm</option></command>
 746         <option></option>
 747         </term>
 748         <listitem>
 749                 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.
 750         <para></para></listitem>
 751 </varlistentry>
 752
 753 <varlistentry>
 754         <term>
 755                 <command><option>i8k_right_fan_status</option></command>
 756         <option></option>
 757         </term>
 758         <listitem>
 759                 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.
 760         <para></para></listitem>
 761 </varlistentry>
 762
 763 <varlistentry>
 764         <term>
 765                 <command><option>i8k_serial</option></command>
 766         <option></option>
 767         </term>
 768         <listitem>
 769                 If running the i8k kernel driver for Inspiron laptops, displays your laptop serial number as listed in /proc/i8k.
 770         <para></para></listitem>
 771 </varlistentry>
 772
 773 <varlistentry>
 774         <term>
 775                 <command><option>i8k_version</option></command>
 776         <option></option>
 777         </term>
 778         <listitem>
 779                 If running the i8k kernel driver for Inspiron laptops, displays the version formatting of /proc/i8k.
 780         <para></para></listitem>
 781 </varlistentry>
 782
 783 <varlistentry>
 784         <term>
 785                 <command><option>ibm_fan</option></command>
 786         </term>
 787         <listitem>
 788                 If running the IBM ACPI, displays the fan speed.
 789         <para></para></listitem>
 790 </varlistentry>
 791
 792 <varlistentry>
 793         <term>
 794                 <command><option>ibm_temps</option></command>
 795                 <option>N</option>
 796         </term>
 797         <listitem>
 798                 If running the IBM ACPI, displays the temperatures
 799                 from the IBM temperature sensors (N=0..7) Sensor 0 is
 800                 on the CPU, 3 is on the GPU.
 801         <para></para></listitem>
 802 </varlistentry>
 803
 804 <varlistentry>
 805         <term>
 806                 <command><option>ibm_volume</option></command>
 807         </term>
 808         <listitem>
 809                 If running the IBM ACPI, displays the "master" volume,
 810         controlled by the volume keys (0-14).
 811         <para></para></listitem>
 812 </varlistentry>
 813
 814 <varlistentry>
 815         <term>
 816                 <command><option>ibm_brightness</option></command>
 817         </term>
 818         <listitem>
 819                 If running the IBM ACPI, displays the brigtness of the
 820         laptops's LCD (0-7).
 821         <para></para></listitem>
 822 </varlistentry>
 823
 824
 825 <varlistentry>
 826         <term>
 827                 <command><option>if_running</option></command>
 828         <option>(process)</option>
 829         </term>
 830         <listitem>
 831                 if PROCESS is running, display everything if_running and the matching $endif
 832         <para></para></listitem>
 833 </varlistentry>
 834
 835 <varlistentry>
 836         <term>
 837                 <command><option>if_existing</option></command>
 838         <option>(file)</option>
 839         </term>
 840         <listitem>
 841                 if FILE exists, display everything between if_existing and the matching $endif
 842         <para></para></listitem>
 843 </varlistentry>
 844
 845 <varlistentry>
 846         <term>
 847                 <command><option>if_mounted</option></command>
 848         <option>(mountpoint)</option>
 849         </term>
 850         <listitem>
 851                 if MOUNTPOINT is mounted, display everything between if_mounted and the matching $endif
 852         <para></para></listitem>
 853 </varlistentry>
 854
 855 <varlistentry>
 856         <term>
 857                 <command><option>imap_messages</option></command>
 858         <option>(args)</option>
 859         </term>
 860         <listitem>
 861                 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 143, default interval is 5 minutes.  If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
 862         <para></para></listitem>
 863 </varlistentry>
 864
 865 <varlistentry>
 866         <term>
 867                 <command><option>imap_unseen</option></command>
 868         <option>(args)</option>
 869         </term>
 870         <listitem>
 871                 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 143, default interval is 5 minutes.  If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
 872         <para></para></listitem>
 873 </varlistentry>
 874
 875 <varlistentry>
 876         <term>
 877                 <command><option>kernel</option></command>
 878         </term>
 879         <listitem>
 880                 Kernel version
 881         <para></para></listitem>
 882 </varlistentry>
 883
 884 <varlistentry>
 885         <term>
 886                 <command><option>linkstatus</option></command>
 887         <option>interface</option>
 888         </term>
 889         <listitem>
 890                 Get the link status for wireless connections
 891         <para></para></listitem>
 892 </varlistentry>
 893
 894 <varlistentry>
 895         <term>
 896                 <command><option>loadavg</option></command>
 897         </term>
 898         <listitem>
 899                 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past 5 minutes and 3 for past 15 minutes.
 900         <para></para></listitem>
 901 </varlistentry>
 902
 903 <varlistentry>
 904         <term>
 905                 <command><option>machine</option></command>
 906         </term>
 907         <listitem>
 908                 Machine, i686 for example
 909         <para></para></listitem>
 910 </varlistentry>
 911
 912 <varlistentry>
 913         <term>
 914                 <command><option>mails</option></command>
 915         </term>
 916         <listitem>
 917                 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.
 918         <para></para></listitem>
 919 </varlistentry>
 920
 921 <varlistentry>
 922         <term>
 923                 <command><option>mem</option></command>
 924         </term>
 925         <listitem>
 926                 Amount of memory in use
 927         <para></para></listitem>
 928 </varlistentry>
 929
 930 <varlistentry>
 931         <term>
 932                 <command><option>membar</option></command>
 933         <option>(height),(width)</option>
 934         </term>
 935         <listitem>
 936                 Bar that shows amount of memory in use
 937         <para></para></listitem>
 938 </varlistentry>
 939
 940 <varlistentry>
 941         <term>
 942                 <command><option>memmax</option></command>
 943         </term>
 944         <listitem>
 945                 Total amount of memory
 946         <para></para></listitem>
 947 </varlistentry>
 948
 949 <varlistentry>
 950         <term>
 951                 <command><option>memperc</option></command>
 952         </term>
 953         <listitem>
 954                 Percentage of memory in use
 955         <para></para></listitem>
 956 </varlistentry>
 957
 958 <varlistentry>
 959         <term>
 960                 <command><option>mpd_artist</option></command>
 961         </term>
 962         <listitem>
 963                 Artist in current MPD song must be enabled at compile
 964         <para></para></listitem>
 965 </varlistentry>
 966
 967 <varlistentry>
 968         <term>
 969                 <command><option>mpd_album</option></command>
 970         </term>
 971         <listitem>
 972                 Album in current MPD song
 973         <para></para></listitem>
 974 </varlistentry>
 975
 976 <varlistentry>
 977         <term>
 978                 <command><option>mpd_bar</option></command>
 979         <option>(height),(width)</option>
 980         </term>
 981         <listitem>
 982                 Bar of mpd's progress
 983         <para></para></listitem>
 984 </varlistentry>
 985
 986 <varlistentry>
 987         <term>
 988                 <command><option>mpd_bitrate</option></command>
 989         </term>
 990         <listitem>
 991                 Bitrate of current song
 992         <para></para></listitem>
 993 </varlistentry>
 994
 995 <varlistentry>
 996         <term>
 997                 <command><option>mpd_status</option></command>
 998         </term>
 999         <listitem>
1000                 Playing, stopped, et cetera.
1001         <para></para></listitem>
1002 </varlistentry>
1003
1004 <varlistentry>
1005         <term>
1006                 <command><option>mpd_title</option></command>
1007         </term>
1008         <listitem>
1009                 Title of current MPD song
1010         <para></para></listitem>
1011 </varlistentry>
1012
1013 <varlistentry>
1014         <term>
1015                 <command><option>mpd_vol</option></command>
1016         </term>
1017         <listitem>
1018                 MPD's volume
1019         <para></para></listitem>
1020 </varlistentry>
1021
1022 <varlistentry>
1023         <term>
1024                 <command><option>mpd_elapsed</option></command>
1025         </term>
1026         <listitem>
1027                 Song's elapsed time
1028         <para></para></listitem>
1029 </varlistentry>
1030
1031 <varlistentry>
1032         <term>
1033                 <command><option>mpd_length</option></command>
1034         </term>
1035         <listitem>
1036                 Song's length
1037         <para></para></listitem>
1038 </varlistentry>
1039
1040 <varlistentry>
1041         <term>
1042                 <command><option>mpd_percent</option></command>
1043         </term>
1044         <listitem>
1045                 Percent of song's progress
1046         <para></para></listitem>
1047 </varlistentry>
1048
1049 <varlistentry>
1050         <term>
1051                 <command><option>mpd_random</option></command>
1052         </term>
1053         <listitem>
1054                 Random status (On/Off)
1055         <para></para></listitem>
1056 </varlistentry>
1057
1058 <varlistentry>
1059         <term>
1060                 <command><option>mpd_repeat</option></command>
1061         </term>
1062         <listitem>
1063                 Repeat status (On/Off)
1064         <para></para></listitem>
1065 </varlistentry>
1066
1067 <varlistentry>
1068         <term>
1069                 <command><option>mpd_track</option></command>
1070         </term>
1071         <listitem>
1072                 Prints the MPD track field
1073         <para></para></listitem>
1074 </varlistentry>
1075
1076 <varlistentry>
1077         <term>
1078                 <command><option>mpd_name</option></command>
1079         </term>
1080         <listitem>
1081                 Prints the MPD name field
1082         <para></para></listitem>
1083 </varlistentry>
1084
1085 <varlistentry>
1086         <term>
1087                 <command><option>mpd_file</option></command>
1088         </term>
1089         <listitem>
1090                 Prints the file name of the current MPD song
1091         <para></para></listitem>
1092 </varlistentry>
1093
1094 <varlistentry>
1095         <term>
1096                 <command><option>mpd_smart</option></command>
1097         </term>
1098         <listitem>
1099                 Prints the song name in either the form "artist - title" or file name, depending on whats available
1100         <para></para></listitem>
1101 </varlistentry>
1102
1103 <varlistentry>
1104         <term>
1105                 <command><option>new_mails</option></command>
1106         </term>
1107         <listitem>
1108                 Unread mail count in mail spool.
1109         <para></para></listitem>
1110 </varlistentry>
1111
1112 <varlistentry>
1113         <term>
1114                 <command><option>nodename</option></command>
1115         </term>
1116         <listitem>
1117                 Hostname
1118         <para></para></listitem>
1119 </varlistentry>
1120
1121 <varlistentry>
1122         <term>
1123                 <command><option>outlinecolor</option></command>
1124         <option>(color)</option>
1125         </term>
1126         <listitem>
1127                 Change outline color
1128         <para></para></listitem>
1129 </varlistentry>
1130
1131 <varlistentry>
1132         <term>
1133                 <command><option>pb_battery</option></command>
1134                 <option>item</option>
1135         </term>
1136         <listitem>
1137                 If running on Apple powerbook/ibook, display
1138                 information on battery status. The item parameter
1139                 specifies, what information to display. Exactly one item
1140                 must be specified. Valid items are:
1141                 <simplelist>
1142                         <member><command>status</command>:
1143                                 Display if battery is fully charged, charging,
1144                                 discharging or absent (running on AC)
1145                         </member>
1146                         <member><command>percent</command>:
1147                                 Display charge of battery in percent, if
1148                                 charging or discharging. Nothing will be
1149                                 displayed, if battery is fully charged
1150                                 or absent.
1151                         </member>
1152                         <member><command>time</command>:
1153                                 Display the time remaining until the battery
1154                                 will be fully charged or discharged at current
1155                                 rate.  Nothing is displayed, if battery is
1156                                 absent or if it's present but fully charged
1157                                 and not discharging.
1158                         </member>
1159                 </simplelist>
1160         <para></para></listitem>
1161 </varlistentry>
1162
1163 <varlistentry>
1164         <term>
1165                 <command><option>pop3_unseen</option></command>
1166         <option>(args)</option>
1167         </term>
1168         <listitem>
1169                 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.
1170
1171                 <para></para></listitem>
1172 </varlistentry>
1173
1174 <varlistentry>
1175         <term>
1176                 <command><option>pop3_used</option></command>
1177         <option>(args)</option>
1178         </term>
1179         <listitem>
1180                 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.
1181
1182                 <para></para></listitem>
1183 </varlistentry>
1184
1185 <varlistentry>
1186         <term>
1187                 <command><option>pre_exec</option></command>
1188         <option>shell command</option>
1189         </term>
1190         <listitem>
1191                 Executes a shell command one time before conky displays anything and puts output as text.
1192         <para></para></listitem>
1193 </varlistentry>
1194
1195 <varlistentry>
1196         <term>
1197                 <command><option>processes</option></command>
1198         </term>
1199         <listitem>
1200                 Total processes (sleeping and running)
1201         <para></para></listitem>
1202 </varlistentry>
1203
1204 <varlistentry>
1205         <term>
1206                 <command><option>running_processes</option></command>
1207         </term>
1208         <listitem>
1209                 Running processes (not sleeping), requires Linux 2.6
1210         <para></para></listitem>
1211 </varlistentry>
1212
1213 <varlistentry>
1214         <term>
1215                 <command><option>shadecolor</option></command>
1216         <option>(color)</option>
1217         </term>
1218         <listitem>
1219                 Change shading color
1220         <para></para></listitem>
1221 </varlistentry>
1222
1223 <varlistentry>
1224         <term>
1225                 <command><option>stippled_hr</option></command>
1226         <option>(space)</option>
1227         </term>
1228         <listitem>
1229                 Stippled (dashed) horizontal line
1230         <para></para></listitem>
1231 </varlistentry>
1232
1233 <varlistentry>
1234         <term>
1235                 <command><option>swapbar</option></command>
1236         <option>(height),(width)</option>
1237         </term>
1238         <listitem>
1239                 Bar that shows amount of swap in use
1240         <para></para></listitem>
1241 </varlistentry>
1242
1243 <varlistentry>
1244         <term>
1245                 <command><option>swap</option></command>
1246         </term>
1247         <listitem>
1248                 Amount of swap in use
1249         <para></para></listitem>
1250 </varlistentry>
1251
1252 <varlistentry>
1253         <term>
1254                 <command><option>swapmax</option></command>
1255         </term>
1256         <listitem>
1257                 Total amount of swap
1258         <para></para></listitem>
1259 </varlistentry>
1260
1261 <varlistentry>
1262         <term>
1263                 <command><option>swapperc</option></command>
1264         </term>
1265         <listitem>
1266                 Percentage of swap in use
1267         <para></para></listitem>
1268 </varlistentry>
1269
1270 <varlistentry>
1271         <term>
1272                 <command><option>sysname</option></command>
1273         </term>
1274         <listitem>
1275                 System name, Linux for example
1276         <para></para></listitem>
1277 </varlistentry>
1278
1279 <varlistentry>
1280         <term>
1281                 <command><option>tcp_portmon</option></command>
1282                 <option>port_begin port_end item (index)</option>
1283                 <emphasis>(ip4 only at present)</emphasis>
1284         </term>
1285         <listitem>
1286                 TCP port monitor for specified local ports.  Port numbers must be in the range 1 to 65535. Valid items are:
1287                 <simplelist>
1288                         <member><command>count</command> - total number of connections in the range
1289                                 </member>
1290                         <member><command>rip</command> - remote ip address
1291                                 </member>
1292                         <member><command>rhost</command> - remote host name
1293                                 </member>
1294                         <member><command>rport</command> - remote port number
1295                                 </member>
1296                         <member><command>rservice</command> - remote service name from /etc/services
1297                                 </member>
1298                         <member><command>lip</command> - local ip address
1299                                 </member>
1300                         <member><command>lhost</command> - local host name
1301                                 </member>
1302                         <member><command>lport</command> - local port number
1303                                 </member>
1304                         <member><command>lservice</command> - local service name from /etc/services
1305                                 </member>
1306                 </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.
1307                 <simplelist>
1308                         <member>Examples:</member>
1309                         <member><command>${tcp_portmon 6881 6999 count}</command> -
1310                                 displays the number of connections in the bittorrent port range</member>
1311                         <member><command>${tcp_portmon 22 22 rip 0}</command> -
1312                                 displays the remote host ip of the first sshd connection</member>
1313                         <member><command>${tcp_portmon 22 22 rip 9}</command> -
1314                                 displays the remote host ip of the tenth sshd connection</member>
1315                         <member><command>${tcp_portmon 1 1024 rhost 0}</command> -
1316                                 displays the remote host name of the first connection on a privileged port</member>
1317                         <member><command>${tcp_portmon 1 1024 rport 4}</command> -
1318                                 displays the remote host port of the fifth connection on a privileged port</member>
1319                         <member><command>${tcp_portmon 1 65535 lservice 14}</command> -
1320                                 displays the local service name of the fifteenth connection in the range of all ports</member>
1321                 </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.
1322         </listitem>
1323 </varlistentry>
1324
1325 <varlistentry>
1326         <term>
1327                 <command><option>texeci</option></command>
1328                 <option>interval command</option>
1329         </term>
1330         <listitem>
1331                 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.
1332                 <para></para></listitem>
1333 </varlistentry>
1334
1335 <varlistentry>
1336         <term>
1337                 <command><option>offset</option></command>
1338                 <option>(pixels)</option>
1339         </term>
1340         <listitem>
1341                 Move text over by N pixels.  See also $voffset.
1342                 <para></para></listitem>
1343 </varlistentry>
1344
1345 <varlistentry>
1346         <term>
1347                 <command><option>tab</option></command>
1348                 <option>(width, (start))</option>
1349         </term>
1350         <listitem>
1351         Puts a tab of the specified width, starting from column 'start'.
1352         <para></para></listitem>
1353 </varlistentry>
1354
1355 <varlistentry>
1356         <term>
1357                 <command><option>tail</option></command>
1358                 <option>logfile lines (interval)</option>
1359         </term>
1360         <listitem>
1361                 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.
1362         <para></para></listitem>
1363 </varlistentry>
1364
1365 <varlistentry>
1366         <term>
1367                 <command><option>time</option></command>
1368         <option>(format)</option>
1369         </term>
1370         <listitem>
1371                 Local time, see man strftime to get more information about format
1372         <para></para></listitem>
1373 </varlistentry>
1374
1375 <varlistentry>
1376         <term>
1377                 <command><option>utime</option></command>
1378         <option>(format)</option>
1379         </term>
1380         <listitem>
1381                 Display time in UTC (universal coordinate time).
1382         <para></para></listitem>
1383 </varlistentry>
1384
1385 <varlistentry>
1386         <term>
1387                 <command><option>tztime</option></command>
1388         <option>(timezone) (format)</option>
1389         </term>
1390         <listitem>
1391                 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.
1392         <para></para></listitem>
1393 </varlistentry>
1394
1395 <varlistentry>
1396         <term>
1397                 <command><option>totaldown</option></command>
1398         <option>net</option>
1399         </term>
1400         <listitem>
1401                 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.
1402         <para></para></listitem>
1403 </varlistentry>
1404
1405 <varlistentry>
1406         <term>
1407                 <command><option>top</option></command>
1408         <option>type, num</option>
1409         </term>
1410         <listitem>
1411                 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.
1412         <para></para></listitem>
1413 </varlistentry>
1414
1415 <varlistentry>
1416         <term>
1417                 <command><option>top_mem</option></command>
1418         <option>type, num</option>
1419         </term>
1420         <listitem>
1421                 Same as top, except sorted by mem usage instead of cpu
1422         <para></para></listitem>
1423 </varlistentry>
1424
1425 <varlistentry>
1426         <term>
1427                 <command><option>totalup</option></command>
1428         <option>net</option>
1429         </term>
1430         <listitem>
1431                 Total upload, this one too, may overflow
1432         <para></para></listitem>
1433 </varlistentry>
1434
1435 <varlistentry>
1436         <term>
1437                 <command><option>updates</option></command>
1438         <option>Number of updates</option>
1439         </term>
1440         <listitem>
1441                 for debugging
1442         <para></para></listitem>
1443 </varlistentry>
1444
1445 <varlistentry>
1446         <term>
1447                 <command><option>upspeed</option></command>
1448         <option>net</option>
1449         </term>
1450         <listitem>
1451                 Upload speed in kilobytes
1452         <para></para></listitem>
1453 </varlistentry>
1454
1455 <varlistentry>
1456         <term>
1457                 <command><option>upspeedf</option></command>
1458         <option>net</option>
1459         </term>
1460         <listitem>
1461                 Upload speed in kilobytes with one decimal
1462         <para></para></listitem>
1463 </varlistentry>
1464
1465 <varlistentry>
1466         <term>
1467                 <command><option>upspeedgraph</option></command>
1468                 <option>net (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
1469         </term>
1470         <listitem>
1471                 Upload speed graph, colours defined in hex, minus the #.  If scale is non-zero, it becomes the scale for the graph.
1472         <para></para></listitem>
1473 </varlistentry>
1474
1475 <varlistentry>
1476         <term>
1477                 <command><option>uptime</option></command>
1478         </term>
1479         <listitem>
1480                 Uptime
1481         <para></para></listitem>
1482 </varlistentry>
1483
1484 <varlistentry>
1485         <term>
1486                 <command><option>uptime_short</option></command>
1487         </term>
1488         <listitem>
1489                 Uptime in a shorter format
1490         <para></para></listitem>
1491 </varlistentry>
1492
1493 <varlistentry>
1494         <term>
1495                 <command><option>voffset</option></command>
1496                 <option>(pixels)</option>
1497         </term>
1498         <listitem>
1499                 Change vertical offset by N pixels.  Negative values will cause text to overlap.  See also $offset.
1500                 <para></para></listitem>
1501 </varlistentry>
1502
1503 <varlistentry>
1504         <term>
1505                 <command><option>voltage_mv</option></command>
1506                 <option>(n)</option>
1507         </term>
1508         <listitem>
1509                 Returns CPU #n's voltage in mV. CPUs are
1510                 counted from 1. If omitted, the parameter
1511                 defaults to 1.
1512                 <para></para></listitem>
1513 </varlistentry>
1514
1515 <varlistentry>
1516         <term>
1517                 <command><option>voltage_v</option></command>
1518                 <option>(n)</option>
1519         </term>
1520         <listitem>
1521                 Returns CPU #n's voltage in V. CPUs are
1522                 counted from 1. If omitted, the parameter
1523                 defaults to 1.
1524                 <para></para></listitem>
1525 </varlistentry>
1526
1527 </variablelist>