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