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>addrs</option></command>
  15         <option>interface</option>
  16         </term>
  17         <listitem>
  18                 IP addresses for an interface (if one - works like addr). Linux only.
  19         <para></para></listitem>
  20 </varlistentry>
  21
  22
  23 <varlistentry>
  24         <term>
  25                 <command><option>acpiacadapter</option></command>
  26         </term>
  27         <listitem>
  28                 ACPI ac adapter state.
  29         <para></para></listitem>
  30 </varlistentry>
  31
  32 <varlistentry>
  33         <term>
  34                 <command><option>acpifan</option></command>
  35         </term>
  36         <listitem>
  37                 ACPI fan state
  38         <para></para></listitem>
  39 </varlistentry>
  40
  41 <varlistentry>
  42         <term>
  43                 <command><option>acpitemp</option></command>
  44         </term>
  45         <listitem>
  46                 ACPI temperature in C.
  47                 <para></para></listitem>
  48 </varlistentry>
  49
  50 <varlistentry>
  51         <term>
  52                 <command><option>acpitempf</option></command>
  53         </term>
  54         <listitem>
  55                 ACPI temperature in F.
  56                 <para></para></listitem>
  57 </varlistentry>
  58
  59 <varlistentry>
  60         <term>
  61                 <command><option>adt746xcpu</option></command>
  62         </term>
  63         <listitem>
  64                 CPU temperature from therm_adt746x
  65         <para></para></listitem>
  66 </varlistentry>
  67
  68 <varlistentry>
  69         <term>
  70                 <command><option>adt746xfan</option></command>
  71         </term>
  72         <listitem>
  73                 Fan speed from therm_adt746x
  74         <para></para></listitem>
  75 </varlistentry>
  76
  77 <varlistentry>
  78         <term>
  79                 <command><option>alignr</option></command>
  80         <option>(num)</option>
  81         </term>
  82         <listitem>
  83                 Right-justify text, with space of N
  84         <para></para></listitem>
  85 </varlistentry>
  86
  87 <varlistentry>
  88         <term>
  89                 <command><option>alignc</option></command>
  90         <option>(num)</option>
  91         </term>
  92         <listitem>
  93                 Align text to centre
  94         <para></para></listitem>
  95 </varlistentry>
  96
  97 <varlistentry>
  98         <term>
  99                 <command><option>apm_adapter</option></command>
 100         </term>
 101         <listitem>
 102                 Display APM AC adapter status (FreeBSD only)
 103         <para></para></listitem>
 104 </varlistentry>
 105
 106 <varlistentry>
 107         <term>
 108                 <command><option>apm_battery_life</option></command>
 109         </term>
 110         <listitem>
 111                 Display APM battery life in percent (FreeBSD only)
 112         <para></para></listitem>
 113 </varlistentry>
 114
 115 <varlistentry>
 116         <term>
 117                 <command><option>apm_battery_time</option></command>
 118         </term>
 119         <listitem>
 120                 Display remaining APM battery life in hh:mm:ss or "unknown" if
 121                 AC adapterstatus is on-line or charging (FreeBSD only)
 122         <para></para></listitem>
 123 </varlistentry>
 124
 125 <varlistentry>
 126         <term>
 127                 <command><option>audacious_bar</option></command>
 128                 <option>(height),(width)</option>
 129         </term>
 130         <listitem>
 131                 Progress bar
 132         <para></para></listitem>
 133 </varlistentry>
 134
 135 <varlistentry>
 136         <term>
 137                 <command><option>audacious_bitrate</option></command>
 138         </term>
 139         <listitem>
 140                 Bitrate of current tune
 141         <para></para></listitem>
 142 </varlistentry>
 143
 144 <varlistentry>
 145         <term>
 146                 <command><option>audacious_channels</option></command>
 147         </term>
 148         <listitem>
 149                 Number of audio channels of current tune
 150         <para></para></listitem>
 151 </varlistentry>
 152
 153 <varlistentry>
 154         <term>
 155                 <command><option>audacious_filename</option></command>
 156         </term>
 157         <listitem>
 158                 Full path and filename of current tune
 159         <para></para></listitem>
 160 </varlistentry>
 161
 162 <varlistentry>
 163         <term>
 164                 <command><option>audacious_frequency</option></command>
 165         </term>
 166         <listitem>
 167                 Sampling frequency of current tune
 168         <para></para></listitem>
 169 </varlistentry>
 170
 171 <varlistentry>
 172         <term>
 173                 <command><option>audacious_length</option></command>
 174         </term>
 175         <listitem>
 176                 Total length of current tune as MM:SS
 177         <para></para></listitem>
 178 </varlistentry>
 179
 180 <varlistentry>
 181         <term>
 182                 <command><option>audacious_length_seconds</option></command>
 183         </term>
 184         <listitem>
 185                 Total length of current tune in seconds
 186         <para></para></listitem>
 187 </varlistentry>
 188
 189 <varlistentry>
 190         <term>
 191                 <command><option>audacious_playlist_position</option></command>
 192         </term>
 193         <listitem>
 194                 Playlist position of current tune
 195         <para></para></listitem>
 196 </varlistentry>
 197
 198 <varlistentry>
 199         <term>
 200                 <command><option>audacious_playlist_length</option></command>
 201         </term>
 202         <listitem>
 203                 Number of tunes in playlist
 204         <para></para></listitem>
 205 </varlistentry>
 206
 207 <varlistentry>
 208         <term>
 209                 <command><option>audacious_position</option></command>
 210         </term>
 211         <listitem>
 212                 Position of current tune (MM:SS)
 213         <para></para></listitem>
 214 </varlistentry>
 215
 216 <varlistentry>
 217         <term>
 218                 <command><option>audacious_position_seconds</option></command>
 219         </term>
 220         <listitem>
 221                 Position of current tune in seconds
 222         <para></para></listitem>
 223 </varlistentry>
 224
 225 <varlistentry>
 226         <term>
 227                 <command><option>audacious_status</option></command>
 228         </term>
 229         <listitem>
 230                 Player status (Playing/Paused/Stopped/Not running)
 231         <para></para></listitem>
 232 </varlistentry>
 233
 234 <varlistentry>
 235         <term>
 236                 <command><option>audacious_title</option></command>
 237                 <option>(max length)</option>
 238         </term>
 239         <listitem>
 240                 Title of current tune with optional maximum length specifier
 241         <para></para></listitem>
 242 </varlistentry>
 243
 244 <varlistentry>
 245         <term>
 246                 <command><option>battery</option></command>
 247         <option>(num)</option>
 248         </term>
 249         <listitem>
 250                 Battery status and remaining percentage capacity of ACPI or APM battery. ACPI battery number can be given as argument (default is BAT0).
 251         <para></para></listitem>
 252 </varlistentry>
 253
 254 <varlistentry>
 255         <term>
 256                 <command><option>battery_bar</option></command>
 257         <option>(height),(width) (num)</option>
 258         </term>
 259         <listitem>
 260                 Battery percentage remaining of ACPI battery in a bar.  ACPI battery number can be given as argument (default is BAT0).
 261         <para></para></listitem>
 262 </varlistentry>
 263
 264 <varlistentry>
 265         <term>
 266                 <command><option>battery_percent</option></command>
 267         <option>(num)</option>
 268         </term>
 269         <listitem>
 270                 Battery percentage remaining for ACPI battery.  ACPI battery number can be given as argument (default is BAT0).
 271         <para></para></listitem>
 272 </varlistentry>
 273
 274 <varlistentry>
 275         <term>
 276                 <command><option>battery_time</option></command>
 277         <option>(num)</option>
 278         </term>
 279         <listitem>
 280                 Battery charge/discharge time remaining of ACPI battery.  ACPI battery number can be given as argument (default is BAT0).
 281         <para></para></listitem>
 282 </varlistentry>
 283
 284 <varlistentry>
 285         <term>
 286                 <command><option>bmpx_artist</option></command>
 287         </term>
 288         <listitem>
 289                 Artist in current BMPx track
 290         <para></para></listitem>
 291 </varlistentry>
 292
 293 <varlistentry>
 294         <term>
 295                 <command><option>bmpx_album</option></command>
 296         </term>
 297         <listitem>
 298                 Album in current BMPx track
 299         <para></para></listitem>
 300 </varlistentry>
 301
 302 <varlistentry>
 303         <term>
 304                 <command><option>bmpx_title</option></command>
 305         </term>
 306         <listitem>
 307                 Title of the current BMPx track
 308         <para></para></listitem>
 309 </varlistentry>
 310
 311 <varlistentry>
 312         <term>
 313                 <command><option>bmpx_track</option></command>
 314         </term>
 315         <listitem>
 316                 Track number of the current BMPx track
 317         <para></para></listitem>
 318 </varlistentry>
 319
 320 <varlistentry>
 321         <term>
 322                 <command><option>bmpx_bitrate</option></command>
 323         </term>
 324         <listitem>
 325                 Bitrate of the current BMPx track
 326         <para></para></listitem>
 327 </varlistentry>
 328
 329 <varlistentry>
 330         <term>
 331                 <command><option>bmpx_uri</option></command>
 332         </term>
 333         <listitem>
 334                 URI of the current BMPx track
 335         <para></para></listitem>
 336 </varlistentry>
 337
 338 <varlistentry>
 339         <term>
 340                 <command><option>buffers</option></command>
 341         </term>
 342         <listitem>
 343                 Amount of memory buffered
 344         <para></para></listitem>
 345 </varlistentry>
 346
 347 <varlistentry>
 348         <term>
 349                 <command><option>cached</option></command>
 350         </term>
 351         <listitem>
 352                 Amount of memory cached
 353         <para></para></listitem>
 354 </varlistentry>
 355
 356 <varlistentry>
 357         <term>
 358                 <command><option>color</option></command>
 359         <option>(color)</option>
 360         </term>
 361         <listitem>
 362                 Change drawing color to color
 363         <para></para></listitem>
 364 </varlistentry>
 365
 366 <varlistentry>
 367         <term>
 368                 <command><option>color0</option></command>
 369         </term>
 370         <listitem>
 371                 Change drawing color to color0 configuration option
 372         <para></para></listitem>
 373 </varlistentry>
 374
 375 <varlistentry>
 376         <term>
 377                 <command><option>color1</option></command>
 378         </term>
 379         <listitem>
 380                 Change drawing color to color1 configuration option
 381         <para></para></listitem>
 382 </varlistentry>
 383
 384 <varlistentry>
 385         <term>
 386                 <command><option>color2</option></command>
 387         </term>
 388         <listitem>
 389                 Change drawing color to color2 configuration option
 390         <para></para></listitem>
 391 </varlistentry>
 392
 393 <varlistentry>
 394         <term>
 395                 <command><option>color3</option></command>
 396         </term>
 397         <listitem>
 398                 Change drawing color to color3 configuration option
 399         <para></para></listitem>
 400 </varlistentry>
 401
 402 <varlistentry>
 403         <term>
 404                 <command><option>color4</option></command>
 405         </term>
 406         <listitem>
 407                 Change drawing color to color4 configuration option
 408         <para></para></listitem>
 409 </varlistentry>
 410
 411 <varlistentry>
 412         <term>
 413                 <command><option>color5</option></command>
 414         </term>
 415         <listitem>
 416                 Change drawing color to color5 configuration option
 417         <para></para></listitem>
 418 </varlistentry>
 419
 420 <varlistentry>
 421         <term>
 422                 <command><option>color6</option></command>
 423         </term>
 424         <listitem>
 425                 Change drawing color to color6 configuration option
 426         <para></para></listitem>
 427 </varlistentry>
 428
 429 <varlistentry>
 430         <term>
 431                 <command><option>color7</option></command>
 432         </term>
 433         <listitem>
 434                 Change drawing color to color7 configuration option
 435         <para></para></listitem>
 436 </varlistentry>
 437
 438 <varlistentry>
 439         <term>
 440                 <command><option>color8</option></command>
 441         </term>
 442         <listitem>
 443                 Change drawing color to color8 configuration option
 444         <para></para></listitem>
 445 </varlistentry>
 446
 447 <varlistentry>
 448         <term>
 449                 <command><option>color9</option></command>
 450         </term>
 451         <listitem>
 452                 Change drawing color to color9 configuration option
 453         <para></para></listitem>
 454 </varlistentry>
 455
 456 <varlistentry>
 457         <term>
 458                 <command><option>conky_version</option></command>
 459         </term>
 460         <listitem>
 461                 Conky version
 462         <para></para></listitem>
 463 </varlistentry>
 464
 465 <varlistentry>
 466         <term>
 467                 <command><option>conky_build_date</option></command>
 468         </term>
 469         <listitem>
 470                 Date Conky was built
 471         <para></para></listitem>
 472 </varlistentry>
 473
 474 <varlistentry>
 475         <term>
 476                 <command><option>conky_bulid_arch</option></command>
 477         </term>
 478         <listitem>
 479                 CPU architecture Conky was built for
 480         <para></para></listitem>
 481 </varlistentry>
 482
 483 <varlistentry>
 484         <term>
 485                 <command><option>cpu</option></command>
 486                 <option>(cpuN)</option>
 487         </term>
 488         <listitem>
 489                 CPU usage in percents.  For SMP machines, the CPU number can be provided as an argument.  ${cpu cpu0} is the total usage, and ${cpu cpuX} (X >= 1) are individual CPUs.
 490         <para></para></listitem>
 491 </varlistentry>
 492
 493 <varlistentry>
 494         <term>
 495                 <command><option>cpubar</option></command>
 496                 <option>(cpu number) (height),(width)</option>
 497         </term>
 498         <listitem>
 499                 Bar that shows CPU usage, height is bar's height in pixels.  See $cpu for more info on SMP.
 500         <para></para></listitem>
 501 </varlistentry>
 502
 503 <varlistentry>
 504         <term>
 505                 <command><option>cpugraph</option></command>
 506         <option>(cpu number) (height),(width) (gradient colour 1) (gradient colour 2)</option>
 507         </term>
 508         <listitem>
 509                 CPU usage graph, with optional colours in hex, minus the #.  See $cpu for more info on SMP.
 510         <para></para></listitem>
 511 </varlistentry>
 512
 513 <varlistentry>
 514         <term>
 515                 <command><option>diskio</option></command>
 516                 <option>(device)</option>
 517         </term>
 518         <listitem>
 519                 Displays current disk IO.  Device is optional, and takes the form of sda for /dev/sda.  Individual partitions are allowed.
 520                 <para></para></listitem>
 521 </varlistentry>
 522
 523 <varlistentry>
 524         <term>
 525                 <command><option>diskiograph</option></command>
 526                 <option>(device) (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
 527         </term>
 528         <listitem>
 529                 Disk IO graph, colours defined in hex, minus the #.  If scale is non-zero, it becomes the scale for the graph.
 530                 <para></para></listitem>
 531 </varlistentry>
 532
 533 <varlistentry>
 534         <term>
 535                 <command><option>diskio_read</option></command>
 536                 <option>(device)</option>
 537         </term>
 538         <listitem>
 539                 Displays current disk IO for reads.  Device as in diskio.
 540                 <para></para></listitem>
 541 </varlistentry>
 542
 543 <varlistentry>
 544         <term>
 545                 <command><option>diskiograph_read</option></command>
 546                 <option>(device) (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
 547         </term>
 548         <listitem>
 549                 Disk IO graph for reads, colours defined in hex, minus the #.  If scale is non-zero, it becomes the scale for the graph.  Device as in diskio.
 550                 <para></para></listitem>
 551 </varlistentry>
 552
 553 <varlistentry>
 554         <term>
 555                 <command><option>diskio_write</option></command>
 556                 <option>(device)</option>
 557         </term>
 558         <listitem>
 559                 Displays current disk IO for writes.  Device as in diskio.
 560                 <para></para></listitem>
 561 </varlistentry>
 562
 563 <varlistentry>
 564         <term>
 565                 <command><option>diskiograph_write</option></command>
 566                 <option>(device) (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
 567         </term>
 568         <listitem>
 569                 Disk IO graph for writes, colours defined in hex, minus the #.  If scale is non-zero, it becomes the scale for the graph.  Device as in diskio.
 570                 <para></para></listitem>
 571 </varlistentry>
 572
 573 <varlistentry>
 574         <term>
 575                 <command><option>downspeed</option></command>
 576         <option>net</option>
 577         </term>
 578         <listitem>
 579                 Download speed in kilobytes
 580         <para></para></listitem>
 581 </varlistentry>
 582
 583 <varlistentry>
 584         <term>
 585                 <command><option>downspeedf</option></command>
 586         <option>net</option>
 587         </term>
 588         <listitem>
 589                 Download speed in kilobytes with one decimal
 590         <para></para></listitem>
 591 </varlistentry>
 592
 593 <varlistentry>
 594         <term>
 595                 <command><option>downspeedgraph</option></command>
 596                 <option>net (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
 597         </term>
 598         <listitem>
 599                 Download speed graph, colours defined in hex, minus the #.  If scale is non-zero, it becomes the scale for the graph.
 600         <para></para></listitem>
 601 </varlistentry>
 602
 603 <varlistentry>
 604         <term>
 605                 <command><option>else</option></command>
 606         </term>
 607         <listitem>
 608                 Text to show if any of the above are not true
 609         <para></para></listitem>
 610 </varlistentry>
 611
 612 <varlistentry>
 613         <term>
 614                 <command><option>entropy_avail</option></command>
 615         </term>
 616         <listitem>
 617                 Current entropy available for crypto freaks
 618         <para></para></listitem>
 619 </varlistentry>
 620
 621 <varlistentry>
 622         <term>
 623                 <command><option>entropy_bar</option></command>
 624                 <option>(height),(width)</option>
 625         </term>
 626         <listitem>
 627                 Normalized bar of available entropy for crypto freaks
 628         <para></para></listitem>
 629 </varlistentry>
 630
 631 <varlistentry>
 632         <term>
 633                 <command><option>entropy_poolsize</option></command>
 634         </term>
 635         <listitem>
 636                 Total size of system entropy pool for crypto freaks
 637         <para></para></listitem>
 638 </varlistentry>
 639
 640
 641 <varlistentry>
 642         <term>
 643                 <command><option>exec</option></command>
 644         <option>command</option>
 645         </term>
 646         <listitem>
 647                 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.
 648         <para></para></listitem>
 649 </varlistentry>
 650
 651 <varlistentry>
 652         <term>
 653                 <command><option>execbar</option></command>
 654         <option>command</option>
 655         </term>
 656         <listitem>
 657                 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.
 658         <para></para></listitem>
 659 </varlistentry>
 660
 661 <varlistentry>
 662         <term>
 663                 <command><option>execgraph</option></command>
 664         <option>command</option>
 665         </term>
 666         <listitem>
 667                 Same as execbar, but graphs values.
 668         <para></para></listitem>
 669 </varlistentry>
 670
 671 <varlistentry>
 672         <term>
 673                 <command><option>execi</option></command>
 674                 <option>interval command</option>
 675         </term>
 676         <listitem>
 677                 Same as exec but with specific interval. Interval can't be less than update_interval in configuration. See also $texeci
 678                 <para></para></listitem>
 679 </varlistentry>
 680
 681 <varlistentry>
 682         <term>
 683                 <command><option>execibar</option></command>
 684                 <option>interval command</option>
 685         </term>
 686         <listitem>
 687                 Same as execbar, except with an interval
 688                 <para></para></listitem>
 689 </varlistentry>
 690
 691 <varlistentry>
 692         <term>
 693                 <command><option>execigraph</option></command>
 694                 <option>interval command</option>
 695         </term>
 696         <listitem>
 697                 Same as execigraph, but takes an interval arg graphs values
 698                 <para></para></listitem>
 699 </varlistentry>
 700
 701 <varlistentry>
 702         <term>
 703                 <command><option>font</option></command>
 704         <option>(font)</option>
 705         </term>
 706         <listitem>
 707                 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)
 708         <para></para></listitem>
 709 </varlistentry>
 710
 711 <varlistentry>
 712         <term>
 713                 <command><option>freq</option></command>
 714                 <option>(n)</option>
 715         </term>
 716         <listitem>
 717                 Returns CPU #n's frequency in MHz. CPUs are
 718                 counted from 1. If omitted, the parameter
 719                 defaults to 1.
 720                 <para></para></listitem>
 721 </varlistentry>
 722 <varlistentry>
 723         <term>
 724                 <command><option>freq_g</option></command>
 725                 <option>(n)</option>
 726         </term>
 727         <listitem>
 728                 Returns CPU #n's frequency in GHz. CPUs are
 729                 counted from 1. If omitted, the parameter
 730                 defaults to 1.
 731                 <para></para></listitem>
 732 </varlistentry>
 733
 734 <varlistentry>
 735         <term>
 736                 <command><option>freq_dyn</option></command>
 737         </term>
 738         <listitem>
 739                         Returns CPU frequency in MHz, but is calculated by counting to clock cycles to complete an instruction.  Only available for x86/amd64.
 740                         <para></para></listitem>
 741 </varlistentry>
 742
 743 <varlistentry>
 744         <term>
 745                 <command><option>freq_dyn_g</option></command>
 746         </term>
 747         <listitem>
 748                 Returns CPU frequency in GHz, but is calculated by counting to clock cycles to complete an instruction.  Only available for x86/amd64.
 749         <para></para></listitem>
 750 </varlistentry>
 751
 752 <varlistentry>
 753         <term>
 754                 <command><option>fs_bar</option></command>
 755         <option>(height),(width) fs</option>
 756         </term>
 757         <listitem>
 758                 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.
 759         <para></para></listitem>
 760 </varlistentry>
 761
 762 <varlistentry>
 763         <term>
 764                 <command><option>fs_free</option></command>
 765         <option>(fs)</option>
 766         </term>
 767         <listitem>
 768                 Free space on a file system available for users.
 769         <para></para></listitem>
 770 </varlistentry>
 771
 772 <varlistentry>
 773         <term>
 774                 <command><option>fs_free_perc</option></command>
 775         <option>(fs)</option>
 776         </term>
 777         <listitem>
 778                 Free percentage of space on a file system available for users.
 779         <para></para></listitem>
 780 </varlistentry>
 781
 782 <varlistentry>
 783         <term>
 784                 <command><option>fs_size</option></command>
 785         <option>(fs)</option>
 786         </term>
 787         <listitem>
 788                 File system size
 789         <para></para></listitem>
 790 </varlistentry>
 791
 792 <varlistentry>
 793         <term>
 794                 <command><option>fs_type</option></command>
 795         <option>(fs)</option>
 796         </term>
 797         <listitem>
 798                 File system type
 799         <para></para></listitem>
 800 </varlistentry>
 801
 802 <varlistentry>
 803         <term>
 804                 <command><option>fs_used</option></command>
 805         <option>(fs)</option>
 806         </term>
 807         <listitem>
 808                 File system used space
 809         <para></para></listitem>
 810 </varlistentry>
 811
 812 <varlistentry>
 813         <term>
 814                 <command><option>goto</option></command>
 815                 <option>x</option>
 816         </term>
 817         <listitem>
 818         The next element will be printed at position 'x'.
 819                 <para></para></listitem>
 820 </varlistentry>
 821
 822 <varlistentry>
 823         <term>
 824                 <command><option>hddtemp</option></command>
 825                 <option>dev, (host,(port))</option>
 826         </term>
 827         <listitem>
 828                 Displays temperature of a selected hard disk drive as reported by the hddtemp daemon running on host:port.
 829                 Default host is 127.0.0.1, default port is 7634.
 830                 <para></para></listitem>
 831 </varlistentry>
 832
 833 <varlistentry>
 834         <term>
 835                 <command><option>head</option></command>
 836                 <option>logfile lines (interval)</option>
 837         </term>
 838         <listitem>
 839                 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.
 840                 <para></para></listitem>
 841 </varlistentry>
 842
 843 <varlistentry>
 844         <term>
 845                 <command><option>hr</option></command>
 846         <option>(height)</option>
 847         </term>
 848         <listitem>
 849                 Horizontal line, height is the height in pixels
 850         <para></para></listitem>
 851 </varlistentry>
 852
 853 <varlistentry>
 854   <term>
 855     <command><option>hwmon</option></command>
 856   <option>(dev) type n</option>
 857   </term>
 858   <listitem>
 859     Hwmon sensor from sysfs (Linux 2.6). Parameter dev may be omitted if you have only one hwmon device. Parameter type is either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' (Celsius) or 'tempf' (Fahrenheit) meaning temperature. Parameter n is number of the sensor. See /sys/class/hwmon/ on your local computer.
 860   <para></para></listitem>
 861 </varlistentry>
 862
 863 <varlistentry>
 864         <term>
 865                 <command><option>iconv_start</option></command>
 866         <option>codeset_from codeset_to</option>
 867         </term>
 868         <listitem>
 869                 Convert text from one codeset to another using GNU iconv.  Needs to be stopped with iconv_stop.
 870         <para></para></listitem>
 871 </varlistentry>
 872
 873 <varlistentry>
 874         <term>
 875                 <command><option>iconv_stop</option></command>
 876         <option></option>
 877         </term>
 878         <listitem>
 879                 Stop iconv codeset conversion.
 880         <para></para></listitem>
 881 </varlistentry>
 882
 883 <varlistentry>
 884         <term>
 885                 <command><option>i2c</option></command>
 886         <option>(dev) type n</option>
 887         </term>
 888         <listitem>
 889                 I2C sensor from sysfs (Linux 2.6).  Parameter dev may be omitted if you have only one I2C device.  Parameter type is either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' (Celsius) or 'tempf' (Fahrenheit) meaning temperature.  Parameter n is number of the sensor. See /sys/bus/i2c/devices/ on your local computer.
 890         <para></para></listitem>
 891 </varlistentry>
 892
 893 <varlistentry>
 894         <term>
 895                 <command><option>i8k_ac_status</option></command>
 896         <option></option>
 897         </term>
 898         <listitem>
 899                 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.
 900         <para></para></listitem>
 901 </varlistentry>
 902
 903 <varlistentry>
 904         <term>
 905                 <command><option>i8k_bios</option></command>
 906         <option></option>
 907         </term>
 908         <listitem>
 909                 If running the i8k kernel driver for Inspiron laptops, displays the bios version as listed in /proc/i8k.
 910         <para></para></listitem>
 911 </varlistentry>
 912
 913 <varlistentry>
 914         <term>
 915                 <command><option>i8k_buttons_status</option></command>
 916         <option></option>
 917         </term>
 918         <listitem>
 919                 If running the i8k kernel driver for Inspiron laptops, displays the volume buttons status as listed in /proc/i8k.
 920         <para></para></listitem>
 921 </varlistentry>
 922
 923 <varlistentry>
 924         <term>
 925                 <command><option>i8k_cpu_temp</option></command>
 926         <option></option>
 927         </term>
 928         <listitem>
 929                 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Celsius, as reported by /proc/i8k.
 930         <para></para></listitem>
 931 </varlistentry>
 932
 933 <varlistentry>
 934         <term>
 935                 <command><option>i8k_cpu_tempf</option></command>
 936         <option></option>
 937         </term>
 938         <listitem>
 939                 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Fahrenheit, as reported by /proc/i8k.
 940         <para></para></listitem>
 941 </varlistentry>
 942
 943 <varlistentry>
 944         <term>
 945                 <command><option>i8k_left_fan_rpm</option></command>
 946         <option></option>
 947         </term>
 948         <listitem>
 949                 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.
 950         <para></para></listitem>
 951 </varlistentry>
 952
 953 <varlistentry>
 954         <term>
 955                 <command><option>i8k_left_fan_status</option></command>
 956         <option></option>
 957         </term>
 958         <listitem>
 959                 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.
 960         <para></para></listitem>
 961 </varlistentry>
 962
 963 <varlistentry>
 964         <term>
 965                 <command><option>i8k_right_fan_rpm</option></command>
 966         <option></option>
 967         </term>
 968         <listitem>
 969                 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.
 970         <para></para></listitem>
 971 </varlistentry>
 972
 973 <varlistentry>
 974         <term>
 975                 <command><option>i8k_right_fan_status</option></command>
 976         <option></option>
 977         </term>
 978         <listitem>
 979                 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.
 980         <para></para></listitem>
 981 </varlistentry>
 982
 983 <varlistentry>
 984         <term>
 985                 <command><option>i8k_serial</option></command>
 986         <option></option>
 987         </term>
 988         <listitem>
 989                 If running the i8k kernel driver for Inspiron laptops, displays your laptop serial number as listed in /proc/i8k.
 990         <para></para></listitem>
 991 </varlistentry>
 992
 993 <varlistentry>
 994         <term>
 995                 <command><option>i8k_version</option></command>
 996         <option></option>
 997         </term>
 998         <listitem>
 999                 If running the i8k kernel driver for Inspiron laptops, displays the version formatting of /proc/i8k.
1000         <para></para></listitem>
1001 </varlistentry>
1002
1003 <varlistentry>
1004         <term>
1005                 <command><option>ibm_fan</option></command>
1006         </term>
1007         <listitem>
1008                 If running the IBM ACPI, displays the fan speed.
1009         <para></para></listitem>
1010 </varlistentry>
1011
1012 <varlistentry>
1013         <term>
1014                 <command><option>ibm_temps</option></command>
1015                 <option>N</option>
1016         </term>
1017         <listitem>
1018                 If running the IBM ACPI, displays the temperatures
1019                 from the IBM temperature sensors (N=0..7) Sensor 0 is
1020                 on the CPU, 3 is on the GPU.
1021         <para></para></listitem>
1022 </varlistentry>
1023
1024 <varlistentry>
1025         <term>
1026                 <command><option>ibm_volume</option></command>
1027         </term>
1028         <listitem>
1029                 If running the IBM ACPI, displays the "master" volume,
1030         controlled by the volume keys (0-14).
1031         <para></para></listitem>
1032 </varlistentry>
1033
1034 <varlistentry>
1035         <term>
1036                 <command><option>ibm_brightness</option></command>
1037         </term>
1038         <listitem>
1039                 If running the IBM ACPI, displays the brigtness of the
1040         laptops's LCD (0-7).
1041         <para></para></listitem>
1042 </varlistentry>
1043
1044 <varlistentry>
1045         <term>
1046                 <command><option>if_empty</option></command>
1047         <option>(var)</option>
1048         </term>
1049         <listitem>
1050                 if conky variable VAR is empty, display everything between $if_empty and the matching $endif
1051         <para></para></listitem>
1052 </varlistentry>
1053
1054 <varlistentry>
1055         <term>
1056                 <command><option>if_running</option></command>
1057         <option>(process)</option>
1058         </term>
1059         <listitem>
1060                 if PROCESS is running, display everything $if_running and the matching $endif
1061         <para></para></listitem>
1062 </varlistentry>
1063
1064 <varlistentry>
1065         <term>
1066                 <command><option>if_existing</option></command>
1067         <option>file (string)</option>
1068         </term>
1069         <listitem>
1070                 if FILE exists, display everything between if_existing and the matching $endif.  The optional second paramater checks for FILE containing the specified string and prints everything between $if_existing and the matching $endif.
1071         <para></para></listitem>
1072 </varlistentry>
1073
1074 <varlistentry>
1075         <term>
1076                 <command><option>if_mounted</option></command>
1077         <option>(mountpoint)</option>
1078         </term>
1079         <listitem>
1080                 if MOUNTPOINT is mounted, display everything between $if_mounted and the matching $endif
1081         <para></para></listitem>
1082 </varlistentry>
1083
1084 <varlistentry>
1085         <term>
1086                 <command><option>if_smapi_bat_installed</option></command>
1087         <option>(INDEX)</option>
1088         </term>
1089         <listitem>
1090                 when using smapi, if the battery with index INDEX is installed, display everything between $if_smapi_bat_installed and the matching $endif
1091         <para></para></listitem>
1092 </varlistentry>
1093
1094 <varlistentry>
1095         <term>
1096                 <command><option>if_up</option></command>
1097         <option>(interface)</option>
1098         </term>
1099         <listitem>
1100                 if INTERFACE exists and is up, display everything between $if_up and the matching $endif
1101         <para></para></listitem>
1102 </varlistentry>
1103
1104 <varlistentry>
1105         <term>
1106                 <command><option>imap_messages</option></command>
1107         <option>(args)</option>
1108         </term>
1109         <listitem>
1110                 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.
1111         <para></para></listitem>
1112 </varlistentry>
1113
1114 <varlistentry>
1115         <term>
1116                 <command><option>imap_unseen</option></command>
1117         <option>(args)</option>
1118         </term>
1119         <listitem>
1120                 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.
1121         <para></para></listitem>
1122 </varlistentry>
1123
1124 <varlistentry>
1125         <term>
1126                 <command><option>kernel</option></command>
1127         </term>
1128         <listitem>
1129                 Kernel version
1130         <para></para></listitem>
1131 </varlistentry>
1132
1133 <varlistentry>
1134         <term>
1135                 <command><option>loadavg</option></command>
1136         </term>
1137         <listitem>
1138                 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past 5 minutes and 3 for past 15 minutes.
1139         <para></para></listitem>
1140 </varlistentry>
1141
1142 <varlistentry>
1143         <term>
1144                 <command><option>machine</option></command>
1145         </term>
1146         <listitem>
1147                 Machine, i686 for example
1148         <para></para></listitem>
1149 </varlistentry>
1150
1151 <varlistentry>
1152         <term>
1153                 <command><option>mails</option></command>
1154         <option>(mailbox)</option>
1155         <option>(interval)</option>
1156         </term>
1157         <listitem>
1158                 Mail count in the specified mailbox or your mail spool if not.
1159                 Both mbox and maildir type mailboxes are supported. You can
1160                 use a program like fetchmail to get mails from some server
1161                 using your favourite protocol. See also new_mails.
1162         <para></para></listitem>
1163 </varlistentry>
1164
1165 <varlistentry>
1166         <term>
1167                 <command><option>mboxscan</option></command>
1168                 <option>(-n number of messages to print) (-fw from width) (-sw subject width) mbox</option>
1169         </term>
1170         <listitem>
1171                 Print a summary of recent messages in an mbox format mailbox.  mbox parameter is the filename of the mailbox (can be encapsulated using '"', ie. ${mboxscan -n 10 "/home/brenden/some box"}
1172         <para></para></listitem>
1173 </varlistentry>
1174
1175 <varlistentry>
1176         <term>
1177                 <command><option>mem</option></command>
1178         </term>
1179         <listitem>
1180                 Amount of memory in use
1181         <para></para></listitem>
1182 </varlistentry>
1183
1184 <varlistentry>
1185         <term>
1186                 <command><option>membar</option></command>
1187         <option>(height),(width)</option>
1188         </term>
1189         <listitem>
1190                 Bar that shows amount of memory in use
1191         <para></para></listitem>
1192 </varlistentry>
1193
1194 <varlistentry>
1195         <term>
1196                 <command><option>memmax</option></command>
1197         </term>
1198         <listitem>
1199                 Total amount of memory
1200         <para></para></listitem>
1201 </varlistentry>
1202
1203 <varlistentry>
1204         <term>
1205                 <command><option>memperc</option></command>
1206         </term>
1207         <listitem>
1208                 Percentage of memory in use
1209         <para></para></listitem>
1210 </varlistentry>
1211
1212 <varlistentry>
1213         <term>
1214                 <command><option>mpd_artist</option></command>
1215         </term>
1216         <listitem>
1217                 Artist in current MPD song must be enabled at compile
1218         <para></para></listitem>
1219 </varlistentry>
1220
1221 <varlistentry>
1222         <term>
1223                 <command><option>mpd_album</option></command>
1224         </term>
1225         <listitem>
1226                 Album in current MPD song
1227         <para></para></listitem>
1228 </varlistentry>
1229
1230 <varlistentry>
1231         <term>
1232                 <command><option>mpd_bar</option></command>
1233         <option>(height),(width)</option>
1234         </term>
1235         <listitem>
1236                 Bar of mpd's progress
1237         <para></para></listitem>
1238 </varlistentry>
1239
1240 <varlistentry>
1241         <term>
1242                 <command><option>mpd_bitrate</option></command>
1243         </term>
1244         <listitem>
1245                 Bitrate of current song
1246         <para></para></listitem>
1247 </varlistentry>
1248
1249 <varlistentry>
1250         <term>
1251                 <command><option>mpd_status</option></command>
1252         </term>
1253         <listitem>
1254                 Playing, stopped, et cetera.
1255         <para></para></listitem>
1256 </varlistentry>
1257
1258 <varlistentry>
1259         <term>
1260                 <command><option>mpd_title</option></command>
1261         <option>(max length)</option>
1262         </term>
1263         <listitem>
1264                 Title of current MPD song
1265         <para></para></listitem>
1266 </varlistentry>
1267
1268 <varlistentry>
1269         <term>
1270                 <command><option>mpd_vol</option></command>
1271         </term>
1272         <listitem>
1273                 MPD's volume
1274         <para></para></listitem>
1275 </varlistentry>
1276
1277 <varlistentry>
1278         <term>
1279                 <command><option>mpd_elapsed</option></command>
1280         </term>
1281         <listitem>
1282                 Song's elapsed time
1283         <para></para></listitem>
1284 </varlistentry>
1285
1286 <varlistentry>
1287         <term>
1288                 <command><option>mpd_length</option></command>
1289         </term>
1290         <listitem>
1291                 Song's length
1292         <para></para></listitem>
1293 </varlistentry>
1294
1295 <varlistentry>
1296         <term>
1297                 <command><option>mpd_percent</option></command>
1298         </term>
1299         <listitem>
1300                 Percent of song's progress
1301         <para></para></listitem>
1302 </varlistentry>
1303
1304 <varlistentry>
1305         <term>
1306                 <command><option>mpd_random</option></command>
1307         </term>
1308         <listitem>
1309                 Random status (On/Off)
1310         <para></para></listitem>
1311 </varlistentry>
1312
1313 <varlistentry>
1314         <term>
1315                 <command><option>mpd_repeat</option></command>
1316         </term>
1317         <listitem>
1318                 Repeat status (On/Off)
1319         <para></para></listitem>
1320 </varlistentry>
1321
1322 <varlistentry>
1323         <term>
1324                 <command><option>mpd_track</option></command>
1325         </term>
1326         <listitem>
1327                 Prints the MPD track field
1328         <para></para></listitem>
1329 </varlistentry>
1330
1331 <varlistentry>
1332         <term>
1333                 <command><option>mpd_name</option></command>
1334         </term>
1335         <listitem>
1336                 Prints the MPD name field
1337         <para></para></listitem>
1338 </varlistentry>
1339
1340 <varlistentry>
1341         <term>
1342                 <command><option>mpd_file</option></command>
1343         </term>
1344         <listitem>
1345                 Prints the file name of the current MPD song
1346         <para></para></listitem>
1347 </varlistentry>
1348
1349 <varlistentry>
1350         <term>
1351                 <command><option>mpd_smart</option></command>
1352         </term>
1353         <listitem>
1354                 Prints the song name in either the form "artist - title" or file name, depending on whats available
1355         <para></para></listitem>
1356 </varlistentry>
1357
1358 <varlistentry>
1359         <term>
1360                 <command><option>new_mails</option></command>
1361         <option>(mailbox)</option>
1362         <option>(interval)</option>
1363         </term>
1364         <listitem>
1365                 Unread mail count in the specified mailbox or mail spool if
1366                 not. Both mbox and maildir type mailboxes are supported.
1367         <para></para></listitem>
1368 </varlistentry>
1369
1370 <varlistentry>
1371         <term>
1372                 <command><option>nodename</option></command>
1373         </term>
1374         <listitem>
1375                 Hostname
1376         <para></para></listitem>
1377 </varlistentry>
1378
1379 <varlistentry>
1380         <term>
1381                 <command><option>outlinecolor</option></command>
1382         <option>(color)</option>
1383         </term>
1384         <listitem>
1385                 Change outline color
1386         <para></para></listitem>
1387 </varlistentry>
1388
1389 <varlistentry>
1390         <term>
1391                 <command><option>pb_battery</option></command>
1392                 <option>item</option>
1393         </term>
1394         <listitem>
1395                 If running on Apple powerbook/ibook, display
1396                 information on battery status. The item parameter
1397                 specifies, what information to display. Exactly one item
1398                 must be specified. Valid items are:
1399                 <simplelist>
1400                         <member><command>status</command>:
1401                                 Display if battery is fully charged, charging,
1402                                 discharging or absent (running on AC)
1403                         </member>
1404                         <member><command>percent</command>:
1405                                 Display charge of battery in percent, if
1406                                 charging or discharging. Nothing will be
1407                                 displayed, if battery is fully charged
1408                                 or absent.
1409                         </member>
1410                         <member><command>time</command>:
1411                                 Display the time remaining until the battery
1412                                 will be fully charged or discharged at current
1413                                 rate.  Nothing is displayed, if battery is
1414                                 absent or if it's present but fully charged
1415                                 and not discharging.
1416                         </member>
1417                 </simplelist>
1418         <para></para></listitem>
1419 </varlistentry>
1420
1421 <varlistentry>
1422   <term>
1423     <command><option>platform</option></command>
1424   <option>(dev) type n</option>
1425   </term>
1426   <listitem>
1427     Platform sensor from sysfs (Linux 2.6). Parameter dev may be omitted if you have only one platform device. Platform type is either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' (Celsius) or 'tempf' (Fahrenheit) meaning temperature. Parameter n is number of the sensor. See /sys/bus/platform/devices/ on your local computer.
1428   <para></para></listitem>
1429 </varlistentry>
1430
1431 <varlistentry>
1432         <term>
1433                 <command><option>pop3_unseen</option></command>
1434         <option>(args)</option>
1435         </term>
1436         <listitem>
1437                 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.
1438
1439                 <para></para></listitem>
1440 </varlistentry>
1441
1442 <varlistentry>
1443         <term>
1444                 <command><option>pop3_used</option></command>
1445         <option>(args)</option>
1446         </term>
1447         <listitem>
1448                 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.
1449
1450                 <para></para></listitem>
1451 </varlistentry>
1452
1453 <varlistentry>
1454         <term>
1455                 <command><option>pre_exec</option></command>
1456         <option>shell command</option>
1457         </term>
1458         <listitem>
1459                 Executes a shell command one time before conky displays anything and puts output as text.
1460         <para></para></listitem>
1461 </varlistentry>
1462
1463 <varlistentry>
1464         <term>
1465                 <command><option>processes</option></command>
1466         </term>
1467         <listitem>
1468                 Total processes (sleeping and running)
1469         <para></para></listitem>
1470 </varlistentry>
1471
1472 <varlistentry>
1473         <term>
1474                 <command><option>running_processes</option></command>
1475         </term>
1476         <listitem>
1477                 Running processes (not sleeping), requires Linux 2.6
1478         <para></para></listitem>
1479 </varlistentry>
1480
1481 <varlistentry>
1482         <term>
1483                 <command><option>shadecolor</option></command>
1484         <option>(color)</option>
1485         </term>
1486         <listitem>
1487                 Change shading color
1488         <para></para></listitem>
1489 </varlistentry>
1490
1491 <varlistentry>
1492         <term>
1493                 <command><option>smapi</option></command>
1494         <option>(ARGS)</option>
1495         </term>
1496         <listitem>
1497                 when using smapi, display contents of the /sys/devices/platform/smapi directory. ARGS are either '(FILENAME)' or 'bat (INDEX) (FILENAME)' to display the corresponding files' content. This is a very raw method of accessing the smapi values. When available, better use one of the smapi_* variables instead.
1498         <para></para></listitem>
1499 </varlistentry>
1500
1501 <varlistentry>
1502         <term>
1503                 <command><option>smapi_bat_perc</option></command>
1504         <option>(INDEX)</option>
1505         </term>
1506         <listitem>
1507                 when using smapi, display the remaining capacity in percent of the battery with index INDEX. This is a separate variable because it supports the 'use_spacer' configuration option.
1508         <para></para></listitem>
1509 </varlistentry>
1510
1511 <varlistentry>
1512         <term>
1513                 <command><option>smapi_bat_bar</option></command>
1514         <option>(INDEX),(height),(width)</option>
1515         </term>
1516         <listitem>
1517                 when using smapi, display the remaining capacity of the battery with index INDEX as a bar.
1518         <para></para></listitem>
1519 </varlistentry>
1520
1521 <varlistentry>
1522         <term>
1523                 <command><option>stippled_hr</option></command>
1524         <option>(space)</option>
1525         </term>
1526         <listitem>
1527                 Stippled (dashed) horizontal line
1528         <para></para></listitem>
1529 </varlistentry>
1530
1531 <varlistentry>
1532         <term>
1533                 <command><option>swapbar</option></command>
1534         <option>(height),(width)</option>
1535         </term>
1536         <listitem>
1537                 Bar that shows amount of swap in use
1538         <para></para></listitem>
1539 </varlistentry>
1540
1541 <varlistentry>
1542         <term>
1543                 <command><option>swap</option></command>
1544         </term>
1545         <listitem>
1546                 Amount of swap in use
1547         <para></para></listitem>
1548 </varlistentry>
1549
1550 <varlistentry>
1551         <term>
1552                 <command><option>swapmax</option></command>
1553         </term>
1554         <listitem>
1555                 Total amount of swap
1556         <para></para></listitem>
1557 </varlistentry>
1558
1559 <varlistentry>
1560         <term>
1561                 <command><option>swapperc</option></command>
1562         </term>
1563         <listitem>
1564                 Percentage of swap in use
1565         <para></para></listitem>
1566 </varlistentry>
1567
1568 <varlistentry>
1569         <term>
1570                 <command><option>sysname</option></command>
1571         </term>
1572         <listitem>
1573                 System name, Linux for example
1574         <para></para></listitem>
1575 </varlistentry>
1576
1577 <varlistentry>
1578         <term>
1579                 <command><option>tcp_portmon</option></command>
1580                 <option>port_begin port_end item (index)</option>
1581                 <emphasis>(ip4 only at present)</emphasis>
1582         </term>
1583         <listitem>
1584                 TCP port monitor for specified local ports.  Port numbers must be in the range 1 to 65535. Valid items are:
1585                 <simplelist>
1586                         <member><command>count</command> - total number of connections in the range
1587                                 </member>
1588                         <member><command>rip</command> - remote ip address
1589                                 </member>
1590                         <member><command>rhost</command> - remote host name
1591                                 </member>
1592                         <member><command>rport</command> - remote port number
1593                                 </member>
1594                         <member><command>rservice</command> - remote service name from /etc/services
1595                                 </member>
1596                         <member><command>lip</command> - local ip address
1597                                 </member>
1598                         <member><command>lhost</command> - local host name
1599                                 </member>
1600                         <member><command>lport</command> - local port number
1601                                 </member>
1602                         <member><command>lservice</command> - local service name from /etc/services
1603                                 </member>
1604                 </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.
1605                 <simplelist>
1606                         <member>Examples:</member>
1607                         <member><command>${tcp_portmon 6881 6999 count}</command> -
1608                                 displays the number of connections in the bittorrent port range</member>
1609                         <member><command>${tcp_portmon 22 22 rip 0}</command> -
1610                                 displays the remote host ip of the first sshd connection</member>
1611                         <member><command>${tcp_portmon 22 22 rip 9}</command> -
1612                                 displays the remote host ip of the tenth sshd connection</member>
1613                         <member><command>${tcp_portmon 1 1024 rhost 0}</command> -
1614                                 displays the remote host name of the first connection on a privileged port</member>
1615                         <member><command>${tcp_portmon 1 1024 rport 4}</command> -
1616                                 displays the remote host port of the fifth connection on a privileged port</member>
1617                         <member><command>${tcp_portmon 1 65535 lservice 14}</command> -
1618                                 displays the local service name of the fifteenth connection in the range of all ports</member>
1619                 </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.
1620         </listitem>
1621 </varlistentry>
1622
1623 <varlistentry>
1624         <term>
1625                 <command><option>texeci</option></command>
1626                 <option>interval command</option>
1627         </term>
1628         <listitem>
1629                 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.
1630                 <para></para></listitem>
1631 </varlistentry>
1632
1633 <varlistentry>
1634         <term>
1635                 <command><option>offset</option></command>
1636                 <option>(pixels)</option>
1637         </term>
1638         <listitem>
1639                 Move text over by N pixels.  See also $voffset.
1640                 <para></para></listitem>
1641 </varlistentry>
1642
1643 <varlistentry>
1644         <term>
1645                 <command><option>rss</option></command>
1646                 <option>url delay_in_minutes action item_num</option>
1647         </term>
1648         <listitem>
1649                 Download and parse RSS feeds. Action may be one of the following: feed_title, item_title (with num par), item_desc (with num par) and item_titles.
1650         <para></para></listitem>
1651 </varlistentry>
1652
1653 <varlistentry>
1654         <term>
1655                 <command><option>tab</option></command>
1656                 <option>(width, (start))</option>
1657         </term>
1658         <listitem>
1659         Puts a tab of the specified width, starting from column 'start'.
1660         <para></para></listitem>
1661 </varlistentry>
1662
1663 <varlistentry>
1664         <term>
1665                 <command><option>tail</option></command>
1666                 <option>logfile lines (interval)</option>
1667         </term>
1668         <listitem>
1669                 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.
1670         <para></para></listitem>
1671 </varlistentry>
1672
1673 <varlistentry>
1674         <term>
1675                 <command><option>time</option></command>
1676         <option>(format)</option>
1677         </term>
1678         <listitem>
1679                 Local time, see man strftime to get more information about format
1680         <para></para></listitem>
1681 </varlistentry>
1682
1683 <varlistentry>
1684         <term>
1685                 <command><option>utime</option></command>
1686         <option>(format)</option>
1687         </term>
1688         <listitem>
1689                 Display time in UTC (universal coordinate time).
1690         <para></para></listitem>
1691 </varlistentry>
1692
1693 <varlistentry>
1694         <term>
1695                 <command><option>tztime</option></command>
1696         <option>(timezone) (format)</option>
1697         </term>
1698         <listitem>
1699                 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.
1700         <para></para></listitem>
1701 </varlistentry>
1702
1703 <varlistentry>
1704         <term>
1705                 <command><option>totaldown</option></command>
1706         <option>net</option>
1707         </term>
1708         <listitem>
1709                 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.
1710         <para></para></listitem>
1711 </varlistentry>
1712
1713 <varlistentry>
1714         <term>
1715                 <command><option>top</option></command>
1716         <option>type, num</option>
1717         </term>
1718         <listitem>
1719                 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", "mem", and "time". There can be a max of 10 processes listed.
1720         <para></para></listitem>
1721 </varlistentry>
1722
1723 <varlistentry>
1724         <term>
1725                 <command><option>top_mem</option></command>
1726         <option>type, num</option>
1727         </term>
1728         <listitem>
1729                 Same as top, except sorted by mem usage instead of cpu
1730         <para></para></listitem>
1731 </varlistentry>
1732
1733 <varlistentry>
1734         <term>
1735                 <command><option>totalup</option></command>
1736         <option>net</option>
1737         </term>
1738         <listitem>
1739                 Total upload, this one too, may overflow
1740         <para></para></listitem>
1741 </varlistentry>
1742
1743 <varlistentry>
1744         <term>
1745                 <command><option>updates</option></command>
1746         <option>Number of updates</option>
1747         </term>
1748         <listitem>
1749                 for debugging
1750         <para></para></listitem>
1751 </varlistentry>
1752
1753 <varlistentry>
1754         <term>
1755                 <command><option>upspeed</option></command>
1756         <option>net</option>
1757         </term>
1758         <listitem>
1759                 Upload speed in kilobytes
1760         <para></para></listitem>
1761 </varlistentry>
1762
1763 <varlistentry>
1764         <term>
1765                 <command><option>upspeedf</option></command>
1766         <option>net</option>
1767         </term>
1768         <listitem>
1769                 Upload speed in kilobytes with one decimal
1770         <para></para></listitem>
1771 </varlistentry>
1772
1773 <varlistentry>
1774         <term>
1775                 <command><option>upspeedgraph</option></command>
1776                 <option>net (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
1777         </term>
1778         <listitem>
1779                 Upload speed graph, colours defined in hex, minus the #.  If scale is non-zero, it becomes the scale for the graph.
1780         <para></para></listitem>
1781 </varlistentry>
1782
1783 <varlistentry>
1784         <term>
1785                 <command><option>uptime</option></command>
1786         </term>
1787         <listitem>
1788                 Uptime
1789         <para></para></listitem>
1790 </varlistentry>
1791
1792 <varlistentry>
1793         <term>
1794                 <command><option>uptime_short</option></command>
1795         </term>
1796         <listitem>
1797                 Uptime in a shorter format
1798         <para></para></listitem>
1799 </varlistentry>
1800
1801 <varlistentry>
1802         <term>
1803                 <command><option>user_number</option></command>
1804         </term>
1805         <listitem>
1806                 Number of users logged in
1807                 <para></para></listitem>
1808 </varlistentry>
1809
1810 <varlistentry>
1811         <term>
1812                 <command><option>user_names</option></command>
1813         </term>
1814         <listitem>
1815                 Lists the names of the users logged in
1816                 <para></para></listitem>
1817 </varlistentry>
1818
1819 <varlistentry>
1820         <term>
1821                 <command><option>user_terms</option></command>
1822         </term>
1823         <listitem>
1824                 Lists the consoles in use
1825                 <para></para></listitem>
1826 </varlistentry>
1827
1828 <varlistentry>
1829         <term>
1830                 <command><option>user_times</option></command>
1831         </term>
1832         <listitem>
1833                 Lists how long users have been logged in for
1834                 <para></para></listitem>
1835 </varlistentry>
1836
1837 <varlistentry>
1838         <term>
1839                 <command><option>voffset</option></command>
1840                 <option>(pixels)</option>
1841         </term>
1842         <listitem>
1843                 Change vertical offset by N pixels.  Negative values will cause text to overlap.  See also $offset.
1844                 <para></para></listitem>
1845 </varlistentry>
1846
1847 <varlistentry>
1848         <term>
1849                 <command><option>voltage_mv</option></command>
1850                 <option>(n)</option>
1851         </term>
1852         <listitem>
1853                 Returns CPU #n's voltage in mV. CPUs are
1854                 counted from 1. If omitted, the parameter
1855                 defaults to 1.
1856                 <para></para></listitem>
1857 </varlistentry>
1858
1859 <varlistentry>
1860         <term>
1861                 <command><option>voltage_v</option></command>
1862                 <option>(n)</option>
1863         </term>
1864         <listitem>
1865                 Returns CPU #n's voltage in V. CPUs are
1866                 counted from 1. If omitted, the parameter
1867                 defaults to 1.
1868                 <para></para></listitem>
1869 </varlistentry>
1870
1871 <varlistentry>
1872         <term>
1873                 <command><option>wireless_essid</option></command>
1874                 <option>net</option>
1875         </term>
1876         <listitem>
1877                 Wireless access point ESSID (Linux only)
1878                 <para></para></listitem>
1879 </varlistentry>
1880
1881 <varlistentry>
1882         <term>
1883                 <command><option>wireless_mode</option></command>
1884                 <option>net</option>
1885         </term>
1886         <listitem>
1887                 Wireless mode (Managed/Ad-Hoc/Master) (Linux only)
1888                 <para></para></listitem>
1889 </varlistentry>
1890
1891 <varlistentry>
1892         <term>
1893                 <command><option>wireless_bitrate</option></command>
1894                 <option>net</option>
1895         </term>
1896         <listitem>
1897                 Wireless bitrate (ie 11 Mb/s) (Linux only)
1898                 <para></para></listitem>
1899 </varlistentry>
1900
1901 <varlistentry>
1902         <term>
1903                 <command><option>wireless_ap</option></command>
1904                 <option>net</option>
1905         </term>
1906         <listitem>
1907                 Wireless access point MAC address (Linux only)
1908         <para></para></listitem>
1909 </varlistentry>
1910
1911 <varlistentry>
1912         <term>
1913                 <command><option>wireless_link_qual</option></command>
1914                 <option>net</option>
1915         </term>
1916         <listitem>
1917                 Wireless link quality (Linux only)
1918         <para></para></listitem>
1919 </varlistentry>
1920
1921 <varlistentry>
1922         <term>
1923                 <command><option>wireless_link_qual_max</option></command>
1924                 <option>net</option>
1925         </term>
1926         <listitem>
1927                 Wireless link quality maximum value (Linux only)
1928         <para></para></listitem>
1929 </varlistentry>
1930
1931 <varlistentry>
1932         <term>
1933                 <command><option>wireless_link_qual_perc</option></command>
1934                 <option>net</option>
1935         </term>
1936         <listitem>
1937                 Wireless link quality in percents (Linux only)
1938         <para></para></listitem>
1939 </varlistentry>
1940
1941 <varlistentry>
1942         <term>
1943                 <command><option>wireless_link_bar</option></command>
1944                 <option>(height), (width) net</option>
1945         </term>
1946         <listitem>
1947                 Wireless link quality bar (Linux only)
1948         <para></para></listitem>
1949 </varlistentry>
1950
1951 <varlistentry>
1952         <term>
1953                 <command><option>xmms2_artist</option></command>
1954         </term>
1955         <listitem>
1956                 Artist in current XMMS2 song
1957         <para></para></listitem>
1958 </varlistentry>
1959
1960 <varlistentry>
1961         <term>
1962                 <command><option>xmms2_album</option></command>
1963         </term>
1964         <listitem>
1965                 Album in current XMMS2 song
1966         <para></para></listitem>
1967 </varlistentry>
1968
1969 <varlistentry>
1970         <term>
1971                 <command><option>xmms2_title</option></command>
1972         </term>
1973         <listitem>
1974                 Title in current XMMS2 song
1975         <para></para></listitem>
1976 </varlistentry>
1977
1978 <varlistentry>
1979         <term>
1980                 <command><option>xmms2_genre</option></command>
1981         </term>
1982         <listitem>
1983                 Genre in current XMMS2 song
1984         <para></para></listitem>
1985 </varlistentry>
1986
1987 <varlistentry>
1988         <term>
1989                 <command><option>xmms2_comment</option></command>
1990         </term>
1991         <listitem>
1992                 Comment in current XMMS2 song
1993         <para></para></listitem>
1994 </varlistentry>
1995
1996 <varlistentry>
1997         <term>
1998                 <command><option>xmms2_decoder</option></command>
1999         </term>
2000         <listitem>
2001                 Decoder plugin used
2002         <para></para></listitem>
2003 </varlistentry>
2004
2005 <varlistentry>
2006         <term>
2007                 <command><option>xmms2_transport</option></command>
2008         </term>
2009         <listitem>
2010                 Transport plugin used
2011         <para></para></listitem>
2012 </varlistentry>
2013
2014 <varlistentry>
2015         <term>
2016                 <command><option>xmms2_url</option></command>
2017         </term>
2018         <listitem>
2019                 Full path to current song
2020 <para></para></listitem>
2021 </varlistentry>
2022
2023 <varlistentry>
2024         <term>
2025                 <command><option>xmms2_tracknr</option></command>
2026         </term>
2027         <listitem>
2028                 Track number in current XMMS2 song
2029 <para></para></listitem>
2030 </varlistentry>
2031
2032 <varlistentry>
2033         <term>
2034                 <command><option>xmms2_bitrate</option></command>
2035         </term>
2036         <listitem>
2037         Bitrate of current song
2038         <para></para></listitem>
2039 </varlistentry>
2040
2041 <varlistentry>
2042         <term>
2043                 <command><option>xmms2_id</option></command>
2044         </term>
2045         <listitem>
2046                 XMMS2 id of current song
2047         <para></para></listitem>
2048 </varlistentry>
2049
2050 <varlistentry>
2051         <term>
2052                 <command><option>xmms2_duration</option></command>
2053         </term>
2054         <listitem>
2055                 Duration of current song
2056         <para></para></listitem>
2057 </varlistentry>
2058
2059 <varlistentry>
2060         <term>
2061                 <command><option>xmms2_elapsed</option></command>
2062         </term>
2063         <listitem>
2064                 Song's elapsed time
2065         <para></para></listitem>
2066 </varlistentry>
2067
2068 <varlistentry>
2069         <term>
2070                 <command><option>xmms2_size</option></command>
2071         </term>
2072         <listitem>
2073         Size of current song
2074         <para></para></listitem>
2075 </varlistentry>
2076
2077 <varlistentry>
2078         <term>
2079                 <command><option>xmms2_percent</option></command>
2080         </term>
2081         <listitem>
2082                 Percent of song's progress
2083         <para></para></listitem>
2084 </varlistentry>
2085
2086 <varlistentry>
2087         <term>
2088                 <command><option>xmms2_status</option></command>
2089         </term>
2090         <listitem>
2091                 XMMS2 status (Playing, Paused, Stopped, or Disconnected)
2092         <para></para></listitem>
2093 </varlistentry>
2094
2095 <varlistentry>
2096         <term>
2097                 <command><option>xmms2_bar</option></command>
2098         <option>(height),(width)</option>
2099         </term>
2100         <listitem>
2101                 Bar of XMMS2's progress
2102         <para></para></listitem>
2103 </varlistentry>
2104
2105 <varlistentry>
2106         <term>
2107                 <command><option>xmms2_smart</option></command>
2108         </term>
2109         <listitem>
2110                 Prints the song name in either the form "artist - title" or file name, depending on whats available
2111         <para></para></listitem>
2112 </varlistentry>
2113
2114 </variablelist>