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