vcs.maemo.org Git - monky/blob - doc/variables.xml

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